Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (21 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.52 KB

Contributing

Pull Requests

This project uses the Git Flow model for branch management and Commitizen to generate meaningful commit messages.

To avoid disappointment and delays by submitting Pull Requests that do not meet these criteria, we strongly recommend that you adopt these tools for your development workflow.

  1. Fork collimator
  2. Create a feature branch (git flow feature start my-new-feature)
  3. Commit your changes (git cz)
  4. Push your changes (git push -u origin feature/my-new-feature)
  5. Create new Pull Request

Also, please include the following:

  • Tests
  • Documentation

Bugs and Other Issues

  • Report problems to the project's issue tracker.
  • You can help us diagnose and fix existing bugs by asking and providing answers for the following:
    • Is the bug reproducible as explained?
    • Is it reproducible in other environments (for instance, on different browsers or devices)?
    • Are the steps to reproduce the bug clear? If not, can you describe how you might reproduce it?
    • What tags should the bug have?
    • Is this bug something you have run into? Would you appreciate it being looked into faster?

IMPORTANT: By submitting a patch, you agree to the terms of the BSD-3 License.