Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 1.97 KB

Contributing to Cactusfix

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with GitHub

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. Make sure your contribution works as expected.
  3. Plant that pull-request!

Any contributions you make will be under the Mozilla Public License 2.0

In short, when you submit code changes, your submissions are understood to be under the same MPL 2.0 that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's issues tab

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

This is an example of a good bug report.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

  • Four (4) spaces for indentation rather than tabs

License

By contributing, you agree that your contributions will be licensed under its MPL 2.0 License.

References

This document was adapted from the open-source contribution guidelines from briandk.