Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

32 lines (19 loc) · 1.49 KB

How to contribute to voyager

TLDR

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible.
  • If possible, use the relevant issue templates to create the issue.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.
  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of voyager will generally not be accepted.

Do you intend to add a new feature or change an existing one?

  • Suggest your change by opening an issue

Do you have questions about the source code or usage?

  • Ask any question about how to use voyager by opening a blank issue.