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: README.md
+31
Original file line number
Diff line number
Diff line change
@@ -73,3 +73,34 @@ Common prefixes:
73
73
- feat: A new feature
74
74
- docs: Documentation changes
75
75
- test: Correct existing tests or add new ones
76
+
77
+
#### Documentation
78
+
- Make sure you put useful comments in your code. Do not comment things that are obvious.
79
+
- 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.
80
+
- If you have modified/added documentation, please ensure that your language is concise and contains no grammar errors.
81
+
- Do not update 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
82
+
83
+
#### Test
84
+
- Make sure to add examples and test cases in your main() function.
85
+
- If you find any algorithm or document without tests, please feel free to create a pull request or issue describing suggested changes.
0 commit comments