Skip to content

Latest commit

 

History

History
75 lines (41 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

75 lines (41 loc) · 2.34 KB

How to Contribute

Great to see you! Help us out by filing bugs or feature requests, assisting others in our forums or by contributing improvements.

Table of Contents

Work with Issues

We use our issue tracker for project communication, discussion and planning.

Create an Issue

Please use one of our provided issue templates if you plan to file an issue. This ensures you provide all the details necessary for us to understand and resolve your case.

If you have a question, please turn to our community forum rather than filing an issue.

Help Out

  • Share your perspective on issues
  • Be helpful and respect others when commenting

Contribute an Improvement

Learn about how to discuss code changes, our code styles and how to file a pull request.

Discuss Code Changes

Create a pull request if you would like to have an in-depth discussion about some piece of code.

Code Style

Most of our code styles are automatically enforced via lint rules and checked as you submit your PR.

Would you like to double check things locally? In this case our lint task is your friend:

npm run lint

Create a Pull Request

We use pull requests for feature additions and bug fixes. If you are not yet familiar on how to create a pull request, read this great guide.

Some things that make it easier for us to accept your pull requests

  • The code adheres to our conventions
    • spaces instead of tabs
    • single-quotes
    • ...
  • The code is tested
  • The npm run all build passes (executes tests + linting)
  • The work is combined into a single commit
  • The commit messages adhere to the conventional commits guidelines

We are happy to assist you if you do not get these things right in the first place.

❤️ from the bpmn.io team.