backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-04-05 03:29:46 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #638 from bhaumikmistry/feat/add-new-file-name-validation-guidelines

Browse Source 
feat - Add new file name guidelines
This commit is contained in:
Bhaumik Mistry
2019-12-03 15:40:25 -05:00
committed by GitHub
parent f3da4bd7c6 d8f55f2715
commit f2b8757132
2 changed files with 25 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.github/pull_request_template.md vendored
View File

@@ -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.

25
CONTRIBUTION.md
View File

@@ -27,8 +27,29 @@ 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.
#### New Directory guidelines
- We recommend adding files to existing directories as much as possible.
- Use lowercase words with ``"_"`` as separator ( no spaces or ```"-"``` allowed )
- For instance
```
SomeNew Fancy-Category is incorrect
some_new_fancy_category is correct
- 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.
- It is recommended to keep your changes grouped logically within individual commits. Contributors find it easier to review changes that are split across multiple commits.
```
git add file_xyz.cpp
git commit -m "your message"
@@ -60,4 +81,4 @@ Common prefixes:
- Checkout our [pull request template](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/.github/pull_request_template.md)
- Most importantly,
- Happy coding!
- Happy coding!