diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 038ba8842..efaaf3765 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,7 +10,8 @@ Contributors guide: https://github.com/TheAlgorithms/C-Plus-Plus/CONTRIBUTION.md - [ ] 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. diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 1f68f9cd5..df2a6b915 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -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. ```