Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 2.77 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. If possible, use appropriate suggested templates.

Contributing via Pull Requests

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

  1. You are working against the latest source on the main branch.
  2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
  3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

To send us a pull request, please:

  1. Fork the repository on GitHub
  2. Clone your repository (git clone https://github.com/XXX/hop-gis-plugins.git && cd hop-gis-plugins)
  3. Create a local branch that will support your dev (git checkout -b a-new-dev)
  4. Commit changes to your local branch branch (git commit -am "Add a new dev")
  5. Push the branch to the central repository (git push origin a-new-dev)
  6. Open a Pull Request answering any default questions
  7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation
  8. Wait for the PR to be supported

GitHub provides additional document on forking a repository and creating a pull request.

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

Code of Conduct

See dedicated page

Security issue notifications

If you discover a potential security issue in this project we ask that you notify AtolCD Security via security@atolcd.com. Please do not create a public github issue.

Licensing

See the LICENSE file for our project's licensing.