Skip to content
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.

Sign up for GitHub

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

[DOC] Update the contributing section of the readme #631

Merged
merged 5 commits into from
Sep 21, 2020
Merged

[DOC] Update the contributing section of the readme #631

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bdb8ead
Update the contributing section of the readme
csouchet Sep 16, 2020
61aa6a0
Merge branch 'master' into update_contributing_part_of_readme
tbouffard Sep 16, 2020
9fca3c9
Merge branch 'master' into update_contributing_part_of_readme
csouchet Sep 17, 2020
abad105
Update README.md
csouchet Sep 17, 2020
4deafd3
Merge branch 'master' into update_contributing_part_of_readme
tbouffard Sep 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,18 @@ Then, we will work on BPMN extensions, library extension points, display options
capacities.


# Development
# Contributing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


To build the project, see the [Contributing guide](CONTRIBUTING.md#Build) :slightly_smiling_face:
To contribute to `bpmn-visualization`, fork and clone this repo locally and commit your code on a separate branch. \
csouchet marked this conversation as resolved.
Show resolved Hide resolved
Please write tests for your code before opening a pull-request:

```sh
npm run test # run all unit & e2e tests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
npm run test # run all unit & e2e tests
npm install
npm run test # run all unit & e2e tests

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@csouchet @aibcmars do you agree with this suggestion? this is the last thing (apply it or not) which blocks the merge

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good, this reflects what we already do in all release notes


# License

Expand Down