Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.92 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Issues and PRs

If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.

We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.

Submitting a pull request

  1. Fork and clone the repository.
  2. Install the correct NodeJS version (highly recommend installing Volta for that).
  3. Configure and install the dependencies: npm install.
  4. Create a new branch following naming convention: git checkout -b (feature|bugfix|hotfix|chore)/(short-description)(/issue-id).
  5. Make your change, test, and make sure BSManager work fine.
  6. Push to your fork and submit a pull request.
  7. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide which is using standard.
  • Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.

Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.