If you need help about how to use the HUD head to the Steam Workshop page discussions and leave a post there! Look within already existing posts to see if someone else had your question answered to save time.
If you encounter a bug you have two options:
- Post a message in the addon's Workshop page bug report thread.
- Open an issue on the repository.
- Describe the problem.
- Provide a brief set of instructions to replicate said problem.
- Post any errors that may popup.
- In case of the problem being related to an addon post either a download link or link its GitHub repository.
- The download link must come from a reputable website (preferably the Steam Workshop).
- If you can't provide a download link because the problem is being caused by a private addon contact its author instead.
Community feedback and contributions are welcome as long as they stay relevant within the repository scope. You can open a pull request and propose improvements to the code base.
- Bug fixes.
- Quality of life improvements.
- Optimization.
- Improving code maintainability.
- Fixing typos on UI related labels (not code).
Preferably, keep pull requests centered around a topic, centering on one change (and kind of change) at a time. And make sure it properly works before submitting -- because no one else will make it work for you.
- It is not properly described.
- It doesn't work properly or causes errors.
- Contains backdoors and other malicious code.
- Unjustified or unrelated mixing of types of contributions (see previous section).
- Code is too difficult to maintain.
- Code is too difficult to read (including lack of comments, proper variable names, ...).
- Code does not follow the style of the rest of the project.
- Irrelevant code changes such as only editing comments or variable names.
- Adds content that probably belongs into a separate addon.