You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+26-26Lines changed: 26 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -2,54 +2,54 @@
2
2
3
3
## Before contributing
4
4
5
-
Welcome to [TheAlgorithms/C-Plus-Plus](https://github.com/TheAlgorithms/C-Plus-Plus)! Before submitting pull requests, please make sure that you have **read the whole guidelines**. If you have any doubts about this contribution guide, please open [an issue](https://github.com/TheAlgorithms/C-Plus-Plus/issues/new/choose) and clearly state your concerns.
5
+
Welcome to [TheAlgorithms/C-Plus-Plus](https://github.com/TheAlgorithms/C-Plus-Plus)! Before submitting pull requests, please make sure that you have **read the whole guidelines**. If you have any doubts about this contribution guide, please open [an issue](https://github.com/TheAlgorithms/C-Plus-Plus/issues/new/choose)or ask in our [Discord server](https://discord.gg/c7MnfGFGa6), and clearly state your concerns.
6
6
7
7
## Contributing
8
8
9
9
### Contributor
10
10
11
-
We are very happy that you consider implementing algorithms and data structures for others! This repository is referred to and used by learners from around the globe. Being one of our contributors, you agree and confirm that:
11
+
Being a contributor at The Algorithms, we request you to follow the points mentioned below:
12
12
13
13
- You did your own work.
14
14
- No plagiarism allowed. Any plagiarized work will not be merged.
15
-
- Your work will be distributed under [MIT License](License) once your pull request has been merged.
16
-
-You submitted work fulfils or mostly fulfils our styles and standards.
15
+
- Your work will be distributed under the [MIT License](https://github.com/TheAlgoritms/C-Plus-Plus/blob/master/LICENSE) once your pull request has been merged.
16
+
-Please follow the repository guidelines and standards mentioned below.
17
17
18
-
**New implementation** New implementation are welcome!
18
+
**New implementation** New implementations are welcome!
19
19
20
-
**Improving comments**and **adding tests** to existing algorithms are much appreciated.
20
+
You can add new algorithms or data structures which are **not present in the repository**or that can **improve** the old implementations (**documentation**, **improving test cases**, removing bugs or in any other resonable sense)
21
21
22
-
**Issues** Please avoid opening issues asking to be "assigned” to a particular algorithm. This merely creates unnecessary noise for maintainers. Instead, please submit your implementation in a pull request and it will be evaluated by project maintainers.
22
+
**Issues** Please avoid opening issues asking to be "assigned” to a particular algorithm. This merely creates unnecessary noise for maintainers. Instead, please submit your implementation in a pull request, and it will be evaluated by project maintainers.
23
23
24
24
### Making Changes
25
25
26
26
#### Code
27
27
28
28
- Please use the directory structure of the repository.
29
-
-File extension for code should be `*.hpp`, `*.h` or `*.cpp`.
30
-
- Don't use **bits/stdc++.h** because this is quite Linuxspecific and slows down the compilation process.
31
-
- Organize your code using **`struct`**, **`class`** and/or **`namespace`** keywords
29
+
-Make sure the file extensions should be `*.hpp`, `*.h` or `*.cpp`.
30
+
- Don't use **`bits/stdc++.h`** because this is quite Linux-specific and slows down the compilation process.
31
+
- Organize your code using **`struct`**, **`class`**, and/or **`namespace`** keywords
32
32
- If an implementation of the algorithm already exists, please refer to the [file-name section below](#new-file-name-guidelines).
33
33
- You can suggest reasonable changes to existing algorithms.
34
34
- Strictly use snake_case (underscore_separated) in filenames.
35
35
- If you have added or modified code, please make sure the code compiles before submitting.
36
-
- Our automated testing runs [__CMake__](https://cmake.org/) on all pull requests so please be sure that your code passes before submitting.
37
-
- Please conform to [doxygen](https://www.doxygen.nl/manual/docblocks.html) standard and document the code as much as possible. This not only facilitates the readers but also generates the correct info on website.
38
-
-**Be consistent in use of these guidelines.**
36
+
- Our automated testing runs [__CMake__](https://cmake.org/) on all the pull requests, so please be sure that your code passes before submitting.
37
+
- Please conform to [Doxygen](https://www.doxygen.nl/manual/docblocks.html) standard and document the code as much as possible. This not only facilitates the readers but also generates the correct info on the website.
38
+
-**Be consistent in the use of these guidelines.**
39
39
40
40
#### Documentation
41
41
42
-
- Make sure you put useful comments in your code. Do not comment things that are obvious.
42
+
- Make sure you put useful comments in your code. Do not comment on obvious things.
43
43
- Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structure. If you want to create a new directory, then please check if a similar category has been recently suggested or created by other pull requests.
44
-
- If you have modified/added documentation, please ensure that your language is concise and contains no grammar errors.
45
-
- Do not update [`README.md`](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/README.md) along with other changes. First create an issue and then link to that issue in your pull request to suggest specific changes required to [`README.md`](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/README.md).
46
-
- The repository follows [Doxygen](https://www.doxygen.nl/manual/docblocks.html) standards and auto-generates the [repository website](https://thealgorithms.github.io/C-Plus-Plus). Please ensure the code is documented in this structure. Sample implementation is given below.
44
+
- If you have modified/added documentation, please ensure that your language is concise and must not contain grammatical errors.
45
+
- Do not update [`README.md`](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/README.md) along with other changes. First, create an issue and then link to that issue in your pull request to suggest specific changes required to [`README.md`](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/README.md).
46
+
- The repository follows [Doxygen](https://www.doxygen.nl/manual/docblocks.html) standards and auto-generates the [repository website](https://thealgorithms.github.io/C-Plus-Plus). Please ensure the code is documented in this structure. A sample implementation is given below.
47
47
48
48
#### Test
49
49
50
-
- Make sure to add examples and test cases in your main() function.
51
-
- If you find any algorithm or document without tests, please feel free to create a pull request or issue describing suggested changes.
52
-
- Please try to add one or more `test()` functions that will invoke the algorithm implementation on random test data with expected output. Use `assert()` function to confirm that the tests will pass. Requires including the `cassert` header.
50
+
- Make sure to add examples and test cases in your `main()` function.
51
+
- If you find an algorithm or document without tests, please feel free to create a pull request or issue describing suggested changes.
52
+
- Please try to add one or more `test()` functions that will invoke the algorithm implementation on random test data with the expected output. Use the`assert()` function to confirm that the tests will pass. Requires including the `cassert` header.
53
53
54
54
#### Typical structure of a program
55
55
@@ -130,7 +130,7 @@ int main(int argc, char *argv[]) {
130
130
131
131
#### New File Name guidelines
132
132
133
-
- Use lowercase words with ``"_"`` as separator
133
+
- Use lowercase words with ``"_"`` as a separator
134
134
- For instance
135
135
136
136
```markdown
@@ -139,8 +139,8 @@ my_new_cpp_class.cpp is correct format
139
139
```
140
140
141
141
- It will be used to dynamically create a directory of files and implementation.
142
-
- File name validation will run on docker to ensure the validity.
143
-
- If an implementation of the algorithm already exists and your version is different from that implemented, please use incremental numeric digit as a suffix. For example, if `median_search.cpp` already exists in the `search` folder and you are contributing a new implementation, the filename should be `median_search2.cpp` and for a third implementation, `median_search3.cpp`.
142
+
- File name validation will run on docker to ensure validity.
143
+
- If an implementation of the algorithm already exists and your version is different from that implemented, please use incremental numeric digit as a suffix. For example: if `median_search.cpp` already exists in the `search` folder, and you are contributing a new implementation, the filename should be `median_search2.cpp` and for a third implementation, `median_search3.cpp`.
144
144
145
145
#### New Directory guidelines
146
146
@@ -158,7 +158,7 @@ some_new_fancy_category is correct
158
158
159
159
#### Commit Guidelines
160
160
161
-
- It is recommended to keep your changes grouped logically within individual commits. Maintainers find it easier to understand changes that are logically spilt across multiple commits. Try to modify just one or two files in the same directory. Pull requests that span multiple directories are often rejected.
161
+
- It is recommended to keep your changes grouped logically within individual commits. Maintainers find it easier to understand changes that are logically spilled across multiple commits. Try to modify just one or two files in the same directory. Pull requests that span multiple directories are often rejected.
0 commit comments