Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 1.58 KB
Raw

Contributing to Bozon

First off, thank you for considering contributing to Bozon. Any help, ideas and inputs are really appreciated!

The following is a set of guidelines for contributing to Bozon. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Submitting Issues

  • You can create an issue here, but before doing that please check existing issues and join conversation instead of creating new one if you find topic related to your issue. Otherwise read the notes below and include as many details as possible with your report. If you can, please include:

  • The version of Bozon you are using

  • The operating system you are using

  • What you were doing when the issue arose and what you expected to happen

What would be also helpful:

  • Screenshots and animated GIFs
  • Error output that appears in your terminal

Submitting Pull Requests

To check that your contributions does not break anything make sure npm test passes.

Please ensure your pull request adheres to the following guidelines:

  • Make an individual pull request for each suggestion
  • The pull request should have a useful title and detailed description
  • Make sure your text editor is set to remove trailing whitespace.
  • Use short, present tense commit messages.
    • Use the present tense ("Add feature" not "Added feature")
    • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
    • Limit the first line to 72 characters or less
    • Reference issues and pull requests liberally