-
-
Notifications
You must be signed in to change notification settings - Fork 620
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature/setup commits validation and contributors readme #3
Feature/setup commits validation and contributors readme #3
Conversation
711da16
to
b6f8f98
Compare
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.
a51e888
to
84ff343
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs change:
- Proper indenting of the filename
- Rephrasing the first sentence starting with
webpack is insanely...
-
.gitignore
follows same style
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use webpack.config.js
as this is a filename
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just replace webpack.config.js with webpack.config.js
👍
|
||
## Documentation | ||
|
||
webpack is insanely feature rich and documentation is a time sink. We |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider rephrasing the first sentence, might be somewhat unclear what you meant
Checking the errors of travis |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should follow the rest of the file style
npm-debug.log | ||
yarn-error.log |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
84ff343
to
9b828c0
Compare
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.
Thx! Nice work @DanielaValero ! |
What this PR do?
Where should the reviewer start?
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 dependencynpm run install-commit-validator
: Will link to pre-commit hook the cli of the commit validatorWhere should the reviewer start?
Checking the contributor documentation