Commit and PR standards

What To Commit

Removing Unwanted .csproj Changes:

In both Assembly-CSharp and Assembly-CSharp-Editor:

1. Locate both Newtonsoft.Json and NSubstitute files
2. Click Settings for all 4 files and select Require Specific Version
3. Build project
4. YER GOOD!!

Committing Standards

Making A Branch:

• All code must be committed to a branch
• When creating a branch, make sure your branch name includes:

• Issue number and title the branch is addressing

• Make sure branch is created off of develop

Ex.

 9-Maintaining-Coding-Standards

Commit Messages:

• Summary must be included
• Try to be as descriptive as possible in summary message

Ex.

 Updated CompletedTasks.txt file

• If commit requires deeper explanation, add to description section in GitHub, but not required

Pull Request:

• Pull request title should match branch name
• In body of pull request, include issue # the pull request addresses so it can reference the issue

Ex.

 (title)Maintaining Coding Standards


 (body)Testing pull request

 Closes issue #9

• Description should include small summary of all commits made (perhaps all commit messages? just be logical here, peeps)

Peer Review:

• Pull request code and logic must be reviewed and approved by at least one other person
• All branches must also have conflicts resolved before attempting to merge into master

Merging Pull Request:

• Once branch has been approved and merged, delete your branch