Skip to content

Latest commit

 

History

History
116 lines (75 loc) · 5.37 KB

CONTRIBUTING.md

File metadata and controls

116 lines (75 loc) · 5.37 KB
Raw

Contributing

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

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:

  • updating the theme & the styling of the site
  • improving the content of the site
  • submitting bug reports in the GitHub Issues
  • improving the README

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. Do the changes in your own fork of the code

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

  4. 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.

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

  6. 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 process-analytics.dev and create a branch with a descriptive name.

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

git checkout -b 4-customize_404_page

IDE configuration

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

Commit in the Pull Request

There is no convention for the commit message in the Pull Request. 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

Open a Pull Request

At this point, you should switch back to your master branch and make sure it's up to date with process-analytics.dev master branch:

git remote add upstream git@github.com:process-analytics/process-analytics.dev.git
git checkout master
git pull upstream master

Then update your feature branch from your local copy of master, and push it!

git checkout 4-customize_404_page
git rebase master
git push --set-upstream origin 4-customize_404_page

Finally, go to GitHub and make a Pull Request ​with labels 😄 For the title, follow the directives of the Pull Request template. Add a screenshot of the rendering of your examples/bpmn-file.

⚠️ We care about quality. So your PR won't be merged until all tests pass.

Sign the Contributor License Agreement

By signing the CLA, we acknowledge that your contribution is accepted as it and that you cannot be held responsible for any impacts on its integration. You then grant us the right to modify and distribute your code without restrictions. We ask this of all contributors in order to assure our users of the origin and continuing existence of the code.

When you contribute to the project on GitHub with a new pull request, the cla-assistant bot will evaluate whether you have signed the CLA. If required, the bot will comment on the pull request, including a link to this system to accept the agreement.

You only need to sign the CLA once or when the CLA terms have changed.

Keeping your Pull Request updated

If a maintainer asks you to rebase your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.

Here's the suggested workflow:

git checkout 4-customize_404_page
git pull --rebase upstream master
git push --force-with-lease 4-customize_404_page

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

Maintainers

Merging a PR (maintainers only)

A PR can only be merged into master by a maintainer, if all of these conditions are met:

  • It is passing CI.
  • It has been approved by at least two maintainers. If it was a maintainer who opened the PR, only one extra approval is needed.
  • It has no requested changes.
  • It is up-to-date with current master.