From da73783da3f1d521fd82c821fb5b5516d5afb523 Mon Sep 17 00:00:00 2001 From: Theeef Date: Sat, 14 May 2022 20:14:39 -0400 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 8f469b5..9ec7286 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # GrubnestCore The Core plugin for the Minecraft Minigame server, The Grubnest + +## How to do work +1. Click the Projects tab above and find the project board for Grubnest Core +2. Look at the To-do column and find a task that is assigned to you +3. Find an epic task. Epic tasks are tasks that have several subtasks that you must complete. Start here +4. Complete your task. For an epic task, start here but for each separate task issue +5. Create a new branch off of the `development`branch for your task. If it's a bug, the branch name should start with "hotfix". If it's an enhancement it should start with "feature". +6. Make any changes you need to implement the issue +7. Create a Pull Request to merge your changes into the `development` branch. +8. Wait for your code to be approved. If you want to work on another issue in the meantime that requires work you did in this issue, when you make your new branch for the next task, make it off of the branch that is under review and not right off `development`. You can rebase the branch after it is merged. +9. If your code is reviewed and you're asked to make changes, ask questions and make them. Repeat steps 7-9 until your code is merged into `development`. + +Follow all database and programming standards (to be posted) when working. For now, comment all methods, use descriptive variable names, and keep all database tables in BCNF (https://www.guru99.com/database-normalization.html).