Skip to content

Commit 2458bb3

Browse files
authored
Update README.md
1 parent 8958239 commit 2458bb3

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,56 @@ All algorithms can be found in the [`DIRECTORY.md`](https://github.com/TheAlgori
1515
## Contribution Guidelines
1616

1717
Please ensure to follow the points stated below if you would like to contribute:
18-
1. Code Quality & Functionality
18+
### 1. Code Quality & Functionality
19+
1920
-Ensure that your code is functional and well-structured before submitting a pull request.
21+
2022
-The code should run without errors in an R environment and produce the expected output.
23+
2124
-Follow best practices for efficiency, readability, and maintainability.
22-
2. Adding a New Algorithm
25+
26+
### 2. Adding a New Algorithm
27+
2328
-Verify that the algorithm is not already implemented in the repository.
29+
2430
-Include a brief explanation of the algorithm in the file as comments.
31+
2532
-Add an example showcasing its usage (it can be commented within the script).
26-
3. Modifying an Existing Algorithm
33+
34+
### 3. Modifying an Existing Algorithm
35+
2736
-If making improvements, clearly document the changes in your pull request description.
37+
2838
-Ensure that your modifications do not break existing functionality.
39+
2940
-If applicable, update or add test cases to validate your changes.
30-
4. Code Style & Naming Conventions
41+
42+
### 4. Code Style & Naming Conventions
43+
3144
-Use consistent and meaningful variable names. Follow one of these naming conventions:
45+
3246
-Use . or _ to separate words (e.g., results.df for a data frame).
47+
3348
-Ensure that filenames follow the existing directory structure and naming patterns.
34-
5. Documentation & Comments
49+
50+
### 5. Documentation & Comments
51+
3552
-Provide clear and concise documentation in the form of comments within the code.
53+
3654
-Add a brief docstring at the beginning of the script explaining:
55+
3756
-What the algorithm does
57+
3858
-The expected input and output
59+
3960
-Any dependencies required
40-
6. Testing & Verification
61+
62+
### 6. Testing & Verification
63+
4164
-Before submitting a pull request, verify that your code:
65+
4266
-Runs correctly with different test cases
67+
4368
-Does not produce unnecessary warnings or errors
44-
-If applicable, add a test file demonstrating the algorithm’s correctness.
69+
70+
-If applicable, add a test file demonstrating the algorithm’s correctness.

0 commit comments

Comments
 (0)