👍🎉 First off, thanks for taking the time to contribute! 🎉👍
Wrye Bash is a mod management utility with a rich set of features. The following is a set of guidelines for contributing to Wrye Bash and its packages. You can contribute either by providing a good bug report, contributing code or making a donation. For basic info on installation and set up see our main readme and links there. In particular:
IMPORTANT: Before posting an issue, be sure to ask at one of the forum threads linked under Questions & Feedback; maybe the bug is already fixed in some development version or you are doing something wrong. Post an issue on github ONLY after doing so and then making sure the bug is not already on the bug tracker by searching on the key elements of your problem
Please also read the relevant page in our wiki.
I'm really glad you're reading this, because we need volunteer developers to help advance this project.
Good starting points are issue 200 and the 'good first issues'.
To contribute, set up a fork and PyCharm as detailed here.
Our wiki contains dev, git and github labelled articles to get you started with setting up the repository and git basics. Please read at least:
- [dev] Coding Style
- [dev] Deciphering Source Filenames
- [dev] Commit guidelines
- [git] Syncing a Fork with the main repository.
- [github] Branching Model & Using The Repository
When ready: do not issue a pull request - contact instead a member of the team in the relevant issue or mentioning them on your commit and let them review. Then those branches can be pulled from your fork and integrated with upstream. Once this is done a couple times you get write privileges.
- dev: The main development branch - approved commits end up here. Do not directly push to this branch - push to your branches and contact someone from the owners team in the relevant issue.
- master: The production branch, contains stable releases. Use it only as reference.
- nightly: Bleeding edge branch. Commits land here for testing.
The Governance Model for Wrye-Bash is similar to that laid out for Git for Windows. See that article for details.
Last but not least you can make a difference to Wrye Bash by offering a small donation. Your donation will motivate the expert software developers behind this project to keep working on the complex and time consuming job of keeping Wrye Bash alive. You can donate via paypal on the nexus sites