[DOC] Update the contributing section of the readme #631
Conversation
| @@ -50,10 +50,18 @@ Then, we will work on BPMN extensions, library extension points, display options | |||
| capacities. | |||
|
|
|||
|
|
|||
| # Development | |||
| # Contributing | |||
There was a problem hiding this comment.
what is the purpose of this change? do you prefer having minimal info here because you think it makes easier to start contributing?
In that case, call to npm install is missing I guess
There was a problem hiding this comment.
I got inspired by different readme, like https://rowanmanning.com/posts/writing-a-friendly-readme/
This provides a taste for new contributors, and encourages them to read more.
csouchet
force-pushed
the
update_contributing_part_of_readme
branch
from
519d1cc to
fea80e0
Compare
csouchet
force-pushed
the
update_contributing_part_of_readme
branch
from
fea80e0 to
61aa6a0
Compare
|
|
||
| ```sh | ||
| npm run test # run all unit & e2e tests |
There was a problem hiding this comment.
| npm run test # run all unit & e2e tests | |
| npm install | |
| npm run test # run all unit & e2e tests |
There was a problem hiding this comment.
Here, we just want to remember the criteria for accepting pull requests (just run the test).
So, for me, how to install the dependency should not be in this section.
There was a problem hiding this comment.
This makes sense, I am ok with that.
|
|
||
| You can find more detail in our [Contributing guide](CONTRIBUTING.md#Build). Participation in this open source project is subject to a [Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
|
||
| :sparkles: A BIG thanks to all our contributors :slightly_smiling_face: |
There was a problem hiding this comment.
good, this reflects what we already do in all release notes
Co-authored-by: Thomas Bouffard <[email protected]>
No description provided.