mirror of
https://github.com/TheAlgorithms/C-Plus-Plus.git
synced 2026-02-04 11:07:00 +08:00
feat/ add new file name guidelines
This commit is contained in:
3
.github/pull_request_template.md
vendored
3
.github/pull_request_template.md
vendored
@@ -10,7 +10,8 @@ Contributors guide: https://github.com/TheAlgorithms/C-Plus-Plus/CONTRIBUTION.md
|
||||
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
|
||||
|
||||
- [ ] Added description of change
|
||||
- [ ] Added tests and example, test passes
|
||||
- [ ] Added file name matches [File name guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTION.md#New-File-Name-guidelines)
|
||||
- [ ] Added tests and example, test must pass
|
||||
- [ ] Relevant documentation/comments is changed or added
|
||||
- [ ] PR title follows semantic [commit guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTION.md#Commit-Guidelines)
|
||||
- [ ] Search previous suggestions before making a new one, as yours may be a duplicate.
|
||||
|
||||
@@ -27,6 +27,16 @@ We are very happy that you consider implementing algorithms and data structure f
|
||||
- If you have modified/added code work, make sure the code compiles before submitting.
|
||||
- **Be consistent in use of there guidelines when submitting**
|
||||
|
||||
#### New File Name guidelines
|
||||
- Use lowercase words with ``"_"`` as separator
|
||||
- For instance
|
||||
```
|
||||
MyNewCppClass.cpp is incorrect
|
||||
my_new_cpp_class.cpp is correct format
|
||||
```
|
||||
- It will be used to dynamically create a directory of files and implementation.
|
||||
- File name validation will run on docker to ensure the validity.
|
||||
|
||||
#### Commit Guidelines
|
||||
- It is recommended to keep your changes grouped logically within individual commits. Contributors find it easier to review changes that are silt across multiple commits.
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user