Feature/setup commits validation and contributors readme by DanielaValero · Pull Request #3 · webpack/webpack-cli

DanielaValero · 2016-12-16T19:09:47Z

What this PR do?

Adds a contributor documentation, all the sections are taken from webpack and webpack.js.org
Proposes using a subset of git-flow as branching model. Basically using prefixes for new features and bugfixes. More info in its own commit: abb5f7a
Adds an option to use yarn for the dependencies management
Adds the editorcofig a js beautifier settings of webpack
Adds a commit message validation
Proposes a template for commit messages. Same as the one of angularJS, but without the scope. More info in its own commit: eda7553

Where should the reviewer start?

Checking the contributor documentation
Checking proposed branching model
Checking the proposed commit messages template

How to test manually

For the yarn setup

Just follow the installation instrucctions in the contributing.

For the commit validation

Once you checked out the branch, do:

npm i: Will install the new dependency
npm run install-commit-validator: Will link to pre-commit hook the cli of the commit validator

Where should the reviewer start?

Checking the contributor documentation

jsf-clabot · 2016-12-16T19:09:48Z

All committers have signed the CLA.

In order to have a consistent style on the projects of webpack, we are using for the cli the settings that are used also in webpack.

evenstensberg

Needs change:

Proper indenting of the filename
Rephrasing the first sentence starting with webpack is insanely...
.gitignore follows same style

evenstensberg · 2016-12-16T21:18:40Z

+
+If you are still having difficulty after looking over your configuration carefully, please post
+a question to [StackOverflow with the webpack-cli tag](http://stackoverflow.com/tags/webpack-cli). Questions
+that include your webpack.config.js and relevant files, this way you help others to help you.


Use webpack.config.js as this is a filename

Hi, I don't understand quite right what you mean here, would you be more specific about the change ?... Ah, I got it you meant adding the quotes

Just replace webpack.config.js with webpack.config.js 👍

evenstensberg · 2016-12-16T21:19:44Z

+
+## Documentation
+
+webpack is insanely feature rich and documentation is a time sink. We


Consider rephrasing the first sentence, might be somewhat unclear what you meant

DanielaValero · 2016-12-16T21:26:51Z

Checking the errors of travis

evenstensberg

Should follow the rest of the file style

evenstensberg · 2016-12-16T21:27:55Z

 # npm-debug log
-npm-debug.log
+npm-debug.log
+yarn-error.log


Should be #yarn-debug log and the log should be placed under there or you change #npm-debug log to npm and yarn-debug log

Yarn provides a good hablding of the dependencies on top of npm, using yarn has been adopted not only in the webpack project, but also lots of the loaders. In order to keep consitency across projects, adding it here also.

In order to have an automated workflow to style our code, adding now the beautifier settings of webpack.

In order to allow others to contribute to the project, we need to specify the rules and workflows with which we work. Adding them now in the right place.

In order to allow reviewers of PRs to get quicker into contex and estimate review time of a PR, adding a section to specify a branching model for the project. Basically it takes the feature and bugfix features of git-flow.

When submitting a contribution and opening a PR, the cla bot will automatically be launched. We need to explain the devs what is this about.

In order to have a similar structure in the commit messages of the contributions, adding a commit validation hook, that a subset of the structure of angular.js validation messages.

In order to have a similar strucuture with the core project, adding now the issue and pr templates.

evenstensberg · 2016-12-16T22:36:01Z

Thx! Nice work @DanielaValero !

DanielaValero force-pushed the feature/setup-commits-validation-and-contributors-readme branch from 711da16 to b6f8f98 Compare December 16, 2016 19:16

DanielaValero mentioned this pull request Dec 16, 2016

Webpack CLI - Define features and tasks of the package #4

Closed

3 tasks

feat: Add editorconfig settings from core webpack

89809de

In order to have a consistent style on the projects of webpack, we are using for the cli the settings that are used also in webpack.

DanielaValero force-pushed the feature/setup-commits-validation-and-contributors-readme branch 2 times, most recently from a51e888 to 84ff343 Compare December 16, 2016 20:28

evenstensberg self-assigned this Dec 16, 2016

evenstensberg requested changes Dec 16, 2016

View reviewed changes

DanielaValero added 5 commits December 16, 2016 17:04

feat: Add yarn settings to handle dependencies

34579c7

Yarn provides a good hablding of the dependencies on top of npm, using yarn has been adopted not only in the webpack project, but also lots of the loaders. In order to keep consitency across projects, adding it here also.

feat: Add beautifier config for JS code

64c88ea

In order to have an automated workflow to style our code, adding now the beautifier settings of webpack.

docs: Add contributor documentation based on webpack's one

ae5f168

In order to allow others to contribute to the project, we need to specify the rules and workflows with which we work. Adding them now in the right place.

docs: Add branching model section for contributing

65a8da9

In order to allow reviewers of PRs to get quicker into contex and estimate review time of a PR, adding a section to specify a branching model for the project. Basically it takes the feature and bugfix features of git-flow.

docs: Add CLA section for contributing

17fa093

When submitting a contribution and opening a PR, the cla bot will automatically be launched. We need to explain the devs what is this about.

DanielaValero force-pushed the feature/setup-commits-validation-and-contributors-readme branch from 84ff343 to 9b828c0 Compare December 16, 2016 22:06

DanielaValero added 2 commits December 16, 2016 17:06

feat: Add commit validation and commits template

d0cbfc0

In order to have a similar structure in the commit messages of the contributions, adding a commit validation hook, that a subset of the structure of angular.js validation messages.

docs: Add issue and pr templates of webpack

9b828c0

In order to have a similar strucuture with the core project, adding now the issue and pr templates.

evenstensberg approved these changes Dec 16, 2016

View reviewed changes

evenstensberg merged commit 2731cc3 into master Dec 16, 2016

evenstensberg deleted the feature/setup-commits-validation-and-contributors-readme branch December 16, 2016 22:35

cpojer mentioned this pull request Jun 12, 2017

chore(tests): Use node env for Jest to avoid JSDOM overhead #164

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Feature/setup commits validation and contributors readme#3

Feature/setup commits validation and contributors readme#3
evenstensberg merged 8 commits into
masterfrom
feature/setup-commits-validation-and-contributors-readme

DanielaValero commented Dec 16, 2016 •

edited

Loading

jsf-clabot commented Dec 16, 2016 •

edited

Loading

evenstensberg left a comment •

edited

Loading

evenstensberg Dec 16, 2016

DanielaValero Dec 16, 2016 •

edited

Loading

evenstensberg Dec 16, 2016

evenstensberg Dec 16, 2016

DanielaValero commented Dec 16, 2016

evenstensberg left a comment

evenstensberg Dec 16, 2016

evenstensberg commented Dec 16, 2016

Labels

3 participants


		## Documentation

		webpack is insanely feature rich and documentation is a time sink. We

Uh oh!

Uh oh!

Conversation

DanielaValero commented Dec 16, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR do?

Where should the reviewer start?

How to test manually

For the yarn setup

For the commit validation

Where should the reviewer start?

jsf-clabot commented Dec 16, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

evenstensberg left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

evenstensberg Dec 16, 2016

Choose a reason for hiding this comment

DanielaValero Dec 16, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

evenstensberg Dec 16, 2016

Choose a reason for hiding this comment

evenstensberg Dec 16, 2016

Choose a reason for hiding this comment

DanielaValero commented Dec 16, 2016

evenstensberg left a comment

Choose a reason for hiding this comment

evenstensberg Dec 16, 2016

Choose a reason for hiding this comment

evenstensberg commented Dec 16, 2016

Labels

3 participants

DanielaValero commented Dec 16, 2016 •

edited

Loading

jsf-clabot commented Dec 16, 2016 •

edited

Loading

evenstensberg left a comment •

edited

Loading

DanielaValero Dec 16, 2016 •

edited

Loading