From f8e1cb388c8ab0cb31eb6dc545f73654faae1471 Mon Sep 17 00:00:00 2001 From: bhaumikmistry Date: Mon, 25 Nov 2019 10:49:48 -0500 Subject: [PATCH 1/5] feat/ add new file name guidelines --- .github/pull_request_template.md | 3 ++- CONTRIBUTION.md | 10 ++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) 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. ``` From 7a8b5c93462ccb809d89219fff5cd9b089b6ac8f Mon Sep 17 00:00:00 2001 From: bhaumikmistry Date: Wed, 27 Nov 2019 10:26:36 -0500 Subject: [PATCH 2/5] add new guidelines --- CONTRIBUTION.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index df2a6b915..902ceea6e 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -31,14 +31,14 @@ We are very happy that you consider implementing algorithms and data structure f - Use lowercase words with ``"_"`` as separator - For instance ``` -MyNewCppClass.cpp is incorrect +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. +- 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" From 194b039001fd3941bc020d15fda1c026add5476c Mon Sep 17 00:00:00 2001 From: bhaumikmistry Date: Wed, 27 Nov 2019 10:43:53 -0500 Subject: [PATCH 3/5] add directory guidelines --- CONTRIBUTION.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 902ceea6e..a9cb80f49 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -37,6 +37,16 @@ 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 +- 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 split across multiple commits. ``` From cacd1ebcba6d5b305909feac88abaf05dd6dd894 Mon Sep 17 00:00:00 2001 From: Bhaumik Mistry Date: Mon, 2 Dec 2019 13:03:29 -0500 Subject: [PATCH 4/5] Update CONTRIBUTION.md add new directory updates. --- CONTRIBUTION.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index a9cb80f49..bed0ef9fc 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -38,7 +38,8 @@ my_new_cpp_class.cpp is correct format - File name validation will run on docker to ensure the validity. #### New Directory guidelines -- Use lowercase words with ``"_"`` as separator ( no spaces or '-' allowed ) +- We recommend adding files to existing directories as mush as possible. +- Use lowercase words with ``"_"`` as separator ( no spaces or ```"-"``` allowed ) - For instance ``` SomeNew Fancy-Category is incorrect @@ -80,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! \ No newline at end of file + - Happy coding! From d8f55f2715561560a9dd7b0e037153c5c7d0391b Mon Sep 17 00:00:00 2001 From: Bhaumik Mistry Date: Mon, 2 Dec 2019 13:07:27 -0500 Subject: [PATCH 5/5] Update CONTRIBUTION.md spell change for # new directory guidelines --- CONTRIBUTION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index bed0ef9fc..828964936 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -38,7 +38,7 @@ my_new_cpp_class.cpp is correct format - File name validation will run on docker to ensure the validity. #### New Directory guidelines -- We recommend adding files to existing directories as mush as possible. +- We recommend adding files to existing directories as much as possible. - Use lowercase words with ``"_"`` as separator ( no spaces or ```"-"``` allowed ) - For instance ```