Thanks for taking the time to contribute!
The following is a set of guidelines for contributing to Yardarm. These are just guidelines, not rules, so use your best judgement and feel free to propose changes to this document in a pull request.
Yardarm is built with C#. If you are new to C#, please head here!
- If you have any questions regarding yardarm, open an issue.
Ensure the bug was not already reported by searching on GitHub under issues. If you're unable to find an open issue addressing the bug, open a new issue.
Please pay attention to the following points while opening an issue.
Detailed information is very helpful to understand an issue.
For example:
- How to reproduce the issue, step-by-step.
- The expected behavior (or what is wrong).
- Screenshots if applicable.
- The file that was used for generation.
Pull Requests are always welcome.
- When you edit the code, please make sure everything is building and any and all test succeed.
- Ensure the PR description clearly describes the problem and solution. It should include:
- The document that was used for generation
- The relevant issue number, if applicable.