Contribution Guide - Unknown025/Flans-Mod-Plus GitHub Wiki

To contribute to this project, you need to fork this repo, this will create a copy that's for your personal GitHub account. You can then add commits to this version adding your feature/fix. When you're ready to submit this change for approval, you need to open a pull request. Ensure you are working on the same branch, to avoid any potential issues.

A pull request will list the changes made between the master (This repository) and your fork. To ensure your pull request can be processed as quickly as possible, make sure only the code changes relavent to a single change is in each PR you make. Next, fill out the template and submit your pull request.

Your request will then be reviewed. Either changes can be requested, extra information could be requested, the request be closed, or it accepted. It is normal for any pull request to undergo changes, and it may take several revisions to get to a mergeable state. If changes are requested, commit these changes to your branch and add them to the pull request.

Contributions are highly valued, and can fast-track any changes you want to be made. We'd love to see more contributions in the future. If users are frequently making high quality contributions, we will consider adding them as a maintainer of the repository, so they can directly commit changes.

Overall contribution values

  • There aren't really any set code styles, just follow practice of what is around your changes.
  • Make sure your code is readable and understandable, include comments even if you think something may be obvious.
  • Backwards compatibility is essential, if a change will cause unintended consequences with content not specifically written for your change, these consequences must be universally considered as positive, or your changes must be a opt-in system (default to the old behaviour).
  • Ensure any behaviour is as generic as it can be. If your system could be used for a slightly different purpose as well as your core idea, try to include both. It's far better and more understandable than two separate, mostly duplicate systems.
  • ??