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
You want to contribute to Algo-DS? Awesome! Feel welcome and read the following sections in order to know what and how to work on this repository. If you get into a problem, make an issue, and we'll respond!
3
+
You want to contribute to Algorithms and Data Structures? Cool! Feel welcome and read the following sections in order to know what and how to work on this repository. If you get into a problem, make an issue, and we'll respond!
4
4
5
5
## Why the Guidelines
6
6
@@ -16,15 +16,45 @@ This is repository is aimed towards being a go to section for all new students t
16
16
17
17
These are some general rules so everyone can contribute with no conflicts of any kind, either in code, or between contributors!
18
18
19
-
- Ensure that the code you write contains proper comments and is formatted as the general convention of the language
20
-
- Python code must serve to [PEP8 convention](http://pep8online.com/)
21
-
- Javascript code must adhere to [JSLint Quality](http://jslint.com)
19
+
-:warning:**Fork the repo make a new branch name as your username and do changes else it will not be accepted.**
20
+
-:warning:**Don't update [MAIN README](../README.md) in case of new language addition**, it would be updated once your pull request is accepted.
21
+
-:warning:**Don't update and add name in [CONTRIBUTORS](../CONTRIBUTORS.md)** file it would be added if your pull request is accepted ASAP.
22
+
-:warning:For **new Issue**, make sure that you add in a **good level detail** for the issue you find in the code and also add path to the bug file.
23
+
24
+
### New Code Addition Rules
25
+
26
+
**Developers:***Its not a bug its a feature*:smile:**Programmers:***Its not a feature its LOGICAL ERROR*:sunglasses:
27
+
28
+
- Ensure that the code you write contains **proper comments and is formatted as the general convention** of the language
22
29
- C code must adhere to [GNU Standards](https://www.gnu.org/prep/standards/html_node/Writing-C.html)
23
30
- C++ code must adhere to [Google Coding Style](https://google.github.io/styleguide/cppguide.html)
24
31
- Java Code must adhere to [Google Coding Style](https://google.github.io/styleguide/javaguide.html)
25
-
- kotlin Code must adhere to [Official Conventions](https://kotlinlang.org/docs/reference/coding-conventions.html)
32
+
- Javascript code must adhere to [JSLint Quality](http://jslint.com)
33
+
- Python code must serve to [PEP8 convention](http://pep8online.com/)
34
+
- Kotlin Code must adhere to [Official Conventions](https://kotlinlang.org/docs/reference/coding-conventions.html)
35
+
36
+
- Maintain same directory structure as recommended in [MAIN README](../README.md).
37
+
- Make sure your code has **Proper Identation** so that it would be easy for fellow programmers to read your code.
38
+
-**Add new language you love** except already present but its **mandatory for you to add a Algorithm or a Data Structure code of new language**.
39
+
- Each code snippet should contain some testing inputs and output to make sure that your code works well and specify where it fails.
40
+
41
+
### Want to be Debugger
42
+
43
+
Find bugs in our code and create [issue](https://github.com/GauravWalia19/Algorithms-and-Data-Structures/issues).
44
+
45
+
### BUG FIXING
46
+
47
+
See [bugs issues](https://github.com/GauravWalia19/Algorithms-and-Data-Structures/issues) fix bugs and create [pull request](https://github.com/GauravWalia19/Algorithms-and-Data-Structures/pulls) it will be accepted in 24 hours ASAP.
48
+
49
+
### Add new DOCS
50
+
51
+
Hola guys do you love to write documentation so following instructions are for you.
52
+
53
+
- Maintain same heading structure for the docs as recommended in [MAIN README](../README.md).
54
+
- Don't update [online wiki](https://github.com/GauravWalia19/Algorithms-and-Data-Structures/wiki/wiki) or [wiki file](../docs/wiki.md).
55
+
- Add name same as algorithm or data structure name you are adding.
56
+
- DOCS should be added in docs directory only.
57
+
58
+
### Suggest new features
26
59
27
-
- If an issue is claimed by another contributor, please wait for atleast 10 days before asking claim for the issue.
28
-
- For a new Issue, make sure that you add in a good level detail for the algorithm/Data Structure you are implementing.
29
-
- Each code snippet is to contain some testing inputs to make sure that your code works well and specify where it fails.
30
-
-_Developing..._
60
+
Suggest new feature you think should be added for better open source understanding of Algorithms and Data Structures by creating a [issue](https://github.com/GauravWalia19/Algorithms-and-Data-Structures/issues).
0 commit comments