- Make sure that you have read and understand the error message if there is one. It may help.
- Please do not create an issue if you are making a pull request to fix the issue. Describe it directly in the pull request (refer to the Making Pull Requests section).
- Double check if the issue hasn’t already be fixed with the last version of WorgenX or if there is a similar issue reported.
- If you are a developer, try to fix the problem and consider making a pull request instead. You will be credited in a Contributor section in the README.md file.
Refer to the Security Policy in the SECURITY.md file.
- Make sure you are targeting the dev branch.
- Keep your changes quite minimal and only related to your issue or your feature.
- Keep the naming conventions of the variables, functions the style in terms of whitespaces.
- Describe your pull request by explaining why you are doing a change.
- Your code must be human readable and also explicit.
- Make minimal commits with an explicit name.
- Your pull request must have no conflicts before submitting.
- Of course, your code must compile correctly and the software has to be as stable as before.