Implementation Workflow - Jacob1225/pufferfish-minecraft-mod GitHub Wiki

In order to be consistent in the end-to-end implementation of a feature and prevent game-breaking bugs to be merged into the main branch, each developer should follow these general steps:

1. Create a story on Jira and create a branch for that particular story.

2. Make the necessary feature changes and push the code to the repo.

3. Ask for peer review from 1-2 other developers that can review both the quality of the code (i.e. proper variable names, no dead code, etc.) and can playtest that particular feature. Where appropriate, include proper description and comments within the pull request to describe what the new feature is and how to playtest it.

4. The reviewer should carefully review the pull request. The reviewer should make comments where appropriate on what needs to be improved. A reviewer can reject the pull request if they do not believe it should be merged into the main, granted reasoning is provided.

5. If the feature is appropriate, the reviewer can approve the pull request and leave a comment stating what they reviewed.

6. Once approved, the developer that made the pull request can merge the code into the main branch.

7. Let the team know that the feature has been merged to the main branch once done so that the other developers can pull the latest changes from the main branch. This can help mitigate merge conflicts that may arise.

If there are any concerns in the process, you may bring this up within the team chats or during stand-up meetings.