@@ -15,30 +15,56 @@ All algorithms can be found in the [`DIRECTORY.md`](https://github.com/TheAlgori
15
15
## Contribution Guidelines
16
16
17
17
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
+
19
20
-Ensure that your code is functional and well-structured before submitting a pull request.
21
+
20
22
-The code should run without errors in an R environment and produce the expected output.
23
+
21
24
-Follow best practices for efficiency, readability, and maintainability.
22
- 2 . Adding a New Algorithm
25
+
26
+ ### 2. Adding a New Algorithm
27
+
23
28
-Verify that the algorithm is not already implemented in the repository.
29
+
24
30
-Include a brief explanation of the algorithm in the file as comments.
31
+
25
32
-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
+
27
36
-If making improvements, clearly document the changes in your pull request description.
37
+
28
38
-Ensure that your modifications do not break existing functionality.
39
+
29
40
-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
+
31
44
-Use consistent and meaningful variable names. Follow one of these naming conventions:
45
+
32
46
-Use . or _ to separate words (e.g., results.df for a data frame).
47
+
33
48
-Ensure that filenames follow the existing directory structure and naming patterns.
34
- 5 . Documentation & Comments
49
+
50
+ ### 5. Documentation & Comments
51
+
35
52
-Provide clear and concise documentation in the form of comments within the code.
53
+
36
54
-Add a brief docstring at the beginning of the script explaining:
55
+
37
56
-What the algorithm does
57
+
38
58
-The expected input and output
59
+
39
60
-Any dependencies required
40
- 6 . Testing & Verification
61
+
62
+ ### 6. Testing & Verification
63
+
41
64
-Before submitting a pull request, verify that your code:
65
+
42
66
-Runs correctly with different test cases
67
+
43
68
-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