Skip to content

Commit 83ed2ff

Browse files
Update guidelines in readme (#350)
Co-authored-by: Gagandeep Singh <[email protected]>
1 parent 48eb71a commit 83ed2ff

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ PyDataStructs
66
About
77
-----
88

9-
This project aims to be a Python package for various data structures in computer science. We are also working on the development of various alogorithms including parallel algorithms. To the best of our knowledge, a well-designed library/package which has covered most of the data structures and algorithms including their parallel implementation doesn't exist.
9+
This project aims to be a Python package for various data structures in computer science. We are also working on the development of various alogorithms including parallel algorithms. To the best of our knowledge, a well-designed library/package which has covered most of the data structures and algorithms including their parallel implementation doesn't exist.
1010

1111
Once the software design becomes more stable after a few releases of this package in the near future, we also aim to provide APIs for the code in C++ and Java as well.
1212

@@ -83,8 +83,11 @@ We recommend you to join our [gitter channel](https://gitter.im/codezoned2017/Lo
8383
Please follow the rules and guidelines given below,
8484

8585
1. Follow the [numpydoc docstring guide](https://numpydoc.readthedocs.io/en/latest/format.html).
86-
2. If you are planning to contribute a new data structure then first raise an issue for discussing the API, rather than directly making a PR.
86+
2. If you are planning to contribute a new data structure then first raise an **issue** for discussing the API, rather than directly making a PR. Please go through [Plan of Action for Adding New Data Structures](https://github.com/codezonediitj/pydatastructs/wiki/Plan-of-Action-for-Adding-New-Data-Structures)
8787
3. For the first-time contributors we recommend not to take a complex data structure, rather start with `beginner` or `easy`.
88+
4. We don't assign issues to any individual. Instead, we follow First Come First Serve for taking over issues, i.e., if one contributor has already showed interest then no comment should be made after that as it won't be considered. Anyone willing to work on an issue can comment on the thread that he/she is working on it and raise a PR for the same.
89+
5. Any open PR must be provided with some updates after being reviewed. If it is stalled for more than 4 days, it will be labeled as `Please take over`, meaning that anyone willing to continue that PR can start working on it.
90+
6. PRs that are not related to the project or doesn't follow any guidelines will be labeled as `Could Close`, meaning that the PR is not necessary at the moment.
8891

8992
The following parameters are to be followed to pass the code quality tests for your Pull Requests,
9093

@@ -105,4 +108,4 @@ Thanks to these wonderful people ✨✨:
105108
</a>
106109
</td>
107110
</tr>
108-
</table>
111+
</table>

0 commit comments

Comments
 (0)