Skip to content

Update guidelines in readme #350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 13, 2021
Merged

Update guidelines in readme #350

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38abb1b
update readme
Smit-create Mar 12, 2021
7835333
Update README.md
Smit-create Mar 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ PyDataStructs
About
-----

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.
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.

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.

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

1. Follow the [numpydoc docstring guide](https://numpydoc.readthedocs.io/en/latest/format.html).
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.
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)
3. For the first-time contributors we recommend not to take a complex data structure, rather start with `beginner` or `easy`.
4. We don't assign issues to any individual. It is first come first serve basis. 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.
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.
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.

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

Expand All @@ -105,4 +108,4 @@ Thanks to these wonderful people ✨✨:
</a>
</td>
</tr>
</table>
</table>