Feature/update contributor and readme #185
Conversation
|
Daniela Valero seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. |
DanielaValero
force-pushed
the
feature/update-contributor-and-readme
branch
from
fcccbc1 to
b339af1
Compare
|
Note: Signed the CLA -> https://cla.js.foundation/webpack/karma-webpack?pullRequest=185 |
There was a problem hiding this comment.
If you want to add yarn instructions, I would add them addition to those for npm. Less people use yarn than you might think and more importantly, the project itself doesn't use yarn for script execution.
As a lib, imo the tasks should execute as npm ( which it does ). We can provide standard docs for npm & additional documentation for those that want to use yarn.
They way this looks in it's current state, development on karma-webpack requires the use of yarn, which is not the case.
Outside of that it's g2g.
//cc @MikaAK
DanielaValero
force-pushed
the
feature/update-contributor-and-readme
branch
from
b339af1 to
c4035d4
Compare
After having added yarn to our build system, the setup steps for contributors need also to be updated to be done with yarn instead of npm.
We do want to generate a meaningful history, so when we look back in the past the commit messages help us to understand what was done by the commit. This requires lots of training, and explicit mentions in our contributors guidelines.
In order to enable users to be aware about our rewrite, and still be able to see the code of karma-webpack, adding a note in our README.
|
Hi @d3viant0ne Very good point, I have updated the PR with the changes you've requested. |
|
Hi @d3viant0ne @MikaAK do we have a special workflow to merge a PR ? for example X amount of approvals before merge? |
Please check if the PR fulfills these requirements
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Add note about rewrite in REAME and setup for contributors with yarn plus explicit note about good commit messages.
Relates to: #184
Does this PR introduce a breaking change?
Other information: N/A