Workflow Setup

ISSUE_TEMPLATE.md

@@ -0,0 +1,7 @@
+#### Description of the problem
+<!--Please provide a clear and details information of the bug/data structure to be added.-->
+
+#### Example of the problem
+<!--Provide a reproducible example code which is causing the bug to appear. Leave this section if the problem is not a bug.-->
+
+#### References/Other comments

LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2019- PyDataStructs Development Team
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  a. Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+  b. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+  c. Neither the name of PyDataStructs nor the names of its contributors
+     may be used to endorse or promote products derived from this software
+     without specific prior written permission.
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+<!-- Your title above should be a short description of what
+was changed. Do not include the issue number in the title. -->
+
+#### References to other Issues or PRs or Relevant literature
+<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
+format, e.g. "Fixes #1234". See
+https://github.com/blog/1506-closing-issues-via-pull-requests . Please also
+write a comment on that issue linking back to this pull request once it is
+open. -->
+
+
+#### Brief description of what is fixed or changed
+
+
+#### Other comments

README.md

@@ -1 +1,38 @@
-WORK UNDER PROGRESS!!
+PyDataStructs
+=============
+
+[![Build Status](https://travis-ci.org/codezonediitj/pydatastructs.png?branch=master)](https://travis-ci.org/codezonediitj/pydatastructs)
+
+[![Join the chat at https://gitter.im/codezonediitj/pydatastructs](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dwyl/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+## Contributing [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dwyl/esta/issues)
+
+Who are we?
+-----------
+
+We are a group of people passionate about data structures and algorithms. We eye for implementing all the data structures given [here](https://en.wikipedia.org/wiki/List_of_data_structures). We aim for distributing the package among enthusiastic programmers so that they don't have to implement complex data structures in their day to day tasks.
+
+How are we different?
+---------------------
+
+There are many pre-exisiting packages available in the open source world. However, we plan to implement those data structures which are used by both sports programmers as well as the developers. Currently, to the best of our knowledge, no such dedicated attempt has been made. In fact, we will keep each data strucutres independent from other for easy code reusability.
+
+How to contribute?
+------------------
+
+Follow the steps given below,
+
+1. Fork, https://github.com/codezonediitj/pydatastructs/
+2. Execute, `git clone https://github.com/<your-github-username>/pydatastructs/`
+3. Change your working directory to `../pydatastructs`.
+4. Execute, `git remote add origin_user https://github.com/<your-github-username>/pydatastructs/`
+5. Execute, `git checkout -b <your-new-branch-for-working>`.
+6. Make changes to the code.
+7. Execute, `git add .`.
+8. Execute, `git commit -m "your-commit-message"`.
+9. Execute, `git push origin_user <your-current-branch>`.
+10. Make a PR.
+
+That's it, 10 easy steps for your first contribution. For future contributionsm just follow steps 5 to 10. Make sure that before starting work, always checkout to master and pull the recent changes using the remote `origin` and the start following steps 5 to 10.
+
+See you soon with your first PR.