Fixes Markdown Formatting
This commit is contained in:
parent
6921f9363d
commit
c601391da4
16
README.md
16
README.md
@ -85,24 +85,24 @@ We're really excited that you're interested in contributing! Before submitting y
|
|||||||
|
|
||||||
### Branchs
|
### Branchs
|
||||||
|
|
||||||
- __master__
|
- __master__
|
||||||
The default branch used for the latest stable release. This branch is protected and typically is only merges with release branches.
|
The default branch used for the latest stable release. This branch is protected and typically is only merges with release branches.
|
||||||
- __3.9.0-DEV__
|
- __3.9.0-DEV__
|
||||||
Development for the next minor release of SPT. Minor releases target the latest version of EFT. Late in the minor release cycle the EFT version is frozen for stability to prepare for release. Larger changes to the project structure may be included in minor releases.
|
Development for the next minor release of SPT. Minor releases target the latest version of EFT. Late in the minor release cycle the EFT version is frozen for stability to prepare for release. Larger changes to the project structure may be included in minor releases.
|
||||||
- __3.8.1-DEV__
|
- __3.8.1-DEV__
|
||||||
Development for the next hotfix release of SPT. Hotfix releases include bug fixes and minor features that do not effect the coding structure of the project. Special care is taken to not break server mod stability. These always target the same version of EFT as the last minor release.
|
Development for the next hotfix release of SPT. Hotfix releases include bug fixes and minor features that do not effect the coding structure of the project. Special care is taken to not break server mod stability. These always target the same version of EFT as the last minor release.
|
||||||
|
|
||||||
### Pull Request Guidelines
|
### Pull Request Guidelines
|
||||||
|
|
||||||
- __Keep Them Small__
|
- __Keep Them Small__
|
||||||
If you're fixing a bug, try to keep the changes to the bug fix only. If you're adding a feature, try to keep the changes to the feature only. This will make it easier to review and merge your changes.
|
If you're fixing a bug, try to keep the changes to the bug fix only. If you're adding a feature, try to keep the changes to the feature only. This will make it easier to review and merge your changes.
|
||||||
- __Perform a Self-Review__
|
- __Perform a Self-Review__
|
||||||
Before submitting your changes, review your own code. This will help you catch any mistakes you may have made.
|
Before submitting your changes, review your own code. This will help you catch any mistakes you may have made.
|
||||||
- __Remove Noise__
|
- __Remove Noise__
|
||||||
Remove any unnecessary changes to white space, code style formatting, or some text change that has no impact related to the intention of the PR.
|
Remove any unnecessary changes to white space, code style formatting, or some text change that has no impact related to the intention of the PR.
|
||||||
- __Create a Meaningful Title__
|
- __Create a Meaningful Title__
|
||||||
When creating a PR, make sure the title is meaningful and describes the changes you've made.
|
When creating a PR, make sure the title is meaningful and describes the changes you've made.
|
||||||
- __Write Detailed Commit Messages__
|
- __Write Detailed Commit Messages__
|
||||||
Bring out your table manners, speak the Queen's English and be on your best behaviour.
|
Bring out your table manners, speak the Queen's English and be on your best behaviour.
|
||||||
|
|
||||||
### Style Guide
|
### Style Guide
|
||||||
|
@ -7,3 +7,6 @@ charset = utf-8
|
|||||||
indent_style = space
|
indent_style = space
|
||||||
indent_size = 4
|
indent_size = 4
|
||||||
max_line_length = 120
|
max_line_length = 120
|
||||||
|
|
||||||
|
[*.md]
|
||||||
|
trim_trailing_whitespace = false
|
||||||
|
Loading…
Reference in New Issue
Block a user