Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 5.71 KB

CONTRIBUTING.md

File metadata and controls

90 lines (56 loc) · 5.71 KB
Raw

Contributing

You are here to help on bpmn-visualization? Awesome, feel welcome and read the following guidelines in order to know how to contribute, to ask questions and to make bpmn-visualization such a great tool.

All members of our community are expected to follow our Code of Conduct. Please make sure you are welcoming and friendly in all of our spaces.

Contributions

There are many ways to contribute:

Code and documentation changes guidelines

For all contributions, please respect the following guidelines:

  1. If you've noticed a bug or have a feature request, let us know in the GitHub Issue tracker! So we can confirm the bug or approve your feature, and provide feedback, before starting to code 🙂

  2. If you would like to work on one of the existing issues, please read the following carefully first 👇:

  • Without prior agreement, we only accept external contributions for issues marked with the PR Accepted label.
  • Please always leave a comment in the issue to mention that you'd like to work on the subject.
  • We will check that the description is understood in the same way by you and by us, and that the implementation you envisage can correspond to what we expect.
  • Finally, we'll assign you to the question, so that everyone knows it's taken and no one else will be working on it in parallel.
  • By following the above guidelines, we maximize the chances of contributions being accepted and integrated quickly into bpmn-visualization.
  1. If you see an unlabeled problem you'd like to work on, let us know to start discussions and see if we change our minds and finally accept a contribution. The following sources can give you an idea of whether your request is likely to be successful:
  • Project priorities are tracked in GitHub projects.
  • These projects show which topics are currently being addressed and which have the highest priority.

  1. Do the changes in your own fork of the code.

  2. Do not commit changes to files that are irrelevant to your feature or bugfix (eg: .gitignore).

  3. Provide tests and documentation whenever possible.

  4. Be sure you have followed the code style for the project.

  5. Prior to opening a Pull Request, ensure the build is fully working by locally running npm run all (build, check and test everything).

  6. Open a GitHub Pull Request with your patches. (1 pull request = 1 feature or bug) We will review your contribution and respond as quickly as possible. Keep in mind that this is an open source project, and it may take us some time to get back to you. Your patience is very much appreciated.

  7. If this is your 1st Pull Request, sign the Contributor License Agreement.

  8. Be willing to accept criticism and work on improving your code.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Fork & create a branch

Fork bpmn-visualization and create a branch with a descriptive name.

A good branch name would be (where issue #25 is the ticket you're working on): 25-annotations_to_tasks

ℹ️ Please don't forget to leave a comment under the issue to let other contributors know that this issue is under the development [i.e "in progress", "i am on it"]

git checkout -b 25-annotations_to_tasks

IDE configuration

To know how configure your development environment, see IDE configuration.

Development

You'll find here the necessary information to build, test, lint your code, and some tips too.

Commit in your branch

There is no convention for the commit message in your branch. The most important part is the title of the Pull Request, because:

  • Everyone must use Pull Request, no direct commit allowed on master branch
  • The commits of a Pull Request are almost always squashed
  • The title of the Pull Request is used as proposal for the maintainer merging the Pull Request

Pull Request

After your development finished, you need to open a Pull Request. You'll find here all the necessary information to open it and to keep it updated.

At this point, you're ready to make your changes! Feel free to ask for help. Everyone is a beginner at first 😸

Maintainers

See the necessary information for the Maintainers