Skip to content

Latest commit

 

History

History
61 lines (32 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

61 lines (32 loc) · 3.19 KB

Contributing to Simba.js

Want to contribute to Simba.s? There are a few thing you need to know.

Code of Conduct

Simba.js has adopted Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it.

Open Development

All work on Simba.js happens on GitHub. Both core team members and external contributors send pull request which go through the same review process.

Semantic Versioning

Simba.js follows semantic versioning. We patch versions for bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes.

Every significant change is documented in the changelog file.

Branch organization

Submit all changes to the develop branch. We use separated branch for development and follow git flow to improve as much as possible the code quality.

Commits Standard

We follow the conventional commit guidelines for every commit we do. With this we can create our CHANGELOG automatically. So every commit MUST FOLLOW this standard.

Bugs

We are using GitHub issues for our bugs. We keep a close eye on this and try to make sure your problem doesn't already exists.

Proposing a Change

If you intend to change the public API, or make any non-trivial changes to the implementation we recommend to first check the road map, if your proposal is not ready there, then we recommend filling an issue. This lets us reach an agreement on your proposal before you put significant effort into it.

If you're only fixing a bug, it's fine to submit a pull request right away, but we still recommend to file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.

Your First Pull Request

Working on your first pull request? You can learn how from this free video series:

How to contribute to an Open Source Project on GitHub

Sending a Pull Request

The core team is monitoring for pull request. We will review your pull request and either merge it, request changes to it, or close it with an explanation.

Before submitting a pull request, please make sure the following is done:

  1. Fork the repository and create your branch from master.

  2. Your branch must be called:

    1. In case of a feature: feature/nameOfYourFeature
    2. In case of a bug: hotfix/nameOfTheBug

  3. Run npm i in the repository root.

  4. If you've fixed a bug or added code that should be tested, add tests!

  5. Format your code with eslint (yarn lint).

  6. Finally, your pull request MUST HAVE the same name of your branch.