- Contributing
- Ways to contribute
- Contributing workflow
- Commit convention
- Git branches
- Get started with the overlay locally
- Did you find a bug?
- Do you want to request a feature?
- Did you write a patch that fixes a bug?
- Do you intend to add a new feature yourself or change an existing one?
- Do you want to contribute to the documentation?
- Closing notes
- Improve documentation: fix incomplete or missing docs, bad wording, examples or explanations.
- Give feedback: we are constantly working on making the overlay better, please share how you use the overlay, what features are missing and what is done good.
- Share the overlay: share link to the overlay with anyone who could be interested.
- Contribute to codebase: propose new feature via GitHub Issues or find an existing one that you are interested in and work on it.
- Give us a code review: help us identify problems with source code or make the overlay more performant.
Please see the documentation to understand the git workflow.
In short:
- Decide what you want to contribute.
- If you want to implement a new feature, consider a draft pull request before fully jumping into code.
- After finalizing your work, please follow our commit conventions.
- Submit a PR if everything is fine.
- Get a code review and fix all issues noticed by a maintainer.
- PR is merged, and we're done!
It is important to write clear commit messages to keep the git history clean.
This repo uses commitlint to make commits easier.
- main - This branch reflects what is being published on the main github page.
- release - This is used for working on upcoming releases. After a release is tested, the changes are merged into main.
- backup - This is used as a backup branch, in case main needs to be updated significantly.
Feature branches can be merged into the release branch.
- Install editorconfig extension for your editor.
- Fork the repository, clone or download your fork.
-
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, and a reproducible test case demonstrating the expected behavior that is not occurring.
-
For reporting security vulnerabilities, please go here
Alternatively, send an issue here detailing your inquiry about the program.
If you would like to send a feature request, please go here
-
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.
-
Before submitting, please read the technical documentation to know more about coding conventions and benchmarks.
-
Suggest your change in a draft pull request and start writing code.
-
Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for feature requests by end-users, bug reports and fixes.
This repository has two main sets of documentation: the files in the docs folder, which help you learn about the program, and the C# docblocks, which serves as a reference.
You can help improve the technical documentation or the C# docblocks by making them more coherent, consistent, or readable, adding missing information, correcting factual errors, fixing typos, or bringing them up to date with the latest changes.
To do so, make changes to the documentation source files (located here on GitHub) or C# comments in source code. Then open a pull request to apply your changes to the main branch.
When working with documentation, please take into account proper English grammatical structure and punctuation. Strive for Simple English whenever possible.
This overlay is a volunteer effort. We encourage you to share it with fellow hunters!
Thanks! ❤️ ❤️ ❤️
@DorielRivalet