Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 1.85 KB
Raw

Contributing

There are many ways you can contribute:

  • Reporting bugs
  • Suggesting enhancements
  • Improving documentation
  • Submitting pull requests

Reporting Bugs

Bugs are tracked as GitHub issues. Create an issue and provide the following information:

  • A clear and descriptive title
  • A detailed description of the issue
  • Steps to reproduce the behavior
  • Expected behavior
  • Additional context (if any - stacktraces, screenshots, etc)

Suggesting Enhancements

Enhancement suggestions are also tracked as GitHub issues. When suggesting an enhancement:

  • Use a clear and descriptive title
  • Provide a detailed description of the proposed feature
  • Explain why this enhancement would be useful to most users
  • Provide examples to demonstrate the desired behavior

Pull Requests

Pull requests are welcome. Here's how to get started:

  1. Fork the repository.
  2. Create a new branch: git checkout -b my-new-feature.
  3. Get the project running by executing bin/setup.
  4. Make your changes & add tests.
  5. Run bundle exec rake to ensure all tests and Rubocop checks pass.
  6. Commit your changes: git commit -am 'Add some feature'.
  7. Push to the branch: git push origin my-new-feature.
  8. Submit a pull request.

Ask for help if you need it!

Code Review

Every pull request will go through a code review process. The review may ask for changes before merging. This is a normal part of the process; it ensures that all contributions are of high quality and align with the project's standards.

Documentation

Documentation is the lifeblood of open source, so there are always opportunities to make it better. If you have suggestions or find errors:

  • Open an issue or
  • Submit a pull request with improvements

Questions?

If you have any questions, feel free to create an issue or contact us directly.