Improve README and add templates

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at contact@shivammathur.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing to IPpy
+
+## Contributor Code of Conduct
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+## Workflow
+
+* Fork the project.
+* Make your bug fix or feature addition.
+* Add tests for it. This is important so we don't break it in a future version unintentionally.
+* Send a pull request to the develop branch.
+
+Please make sure that you have [set up your user name and email address](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) for use with Git. Strings such as `silly nick name <root@localhost>` look really stupid in the commit history of a project.
+
+Due to time constraints, you may not always get a quick responce. Please do not take delays personal and feel free to remind me.
+
+## Using IPpy from a Git checkout
+
+The following commands can be used to perform the initial checkout of ippy:
+
+```bash
+$ git clone https://github.com/shivammathur/ippy.git
+
+$ cd ippy
+```
+
+Install IPpy manually
+
+```bash
+$ python setup.py install
+```
+
+## Using IPpy using PyPI
+```bash
+pip install ippy
+```
+
+## Running the test suite
+
+After following the steps shown above, The `tox` tests in the `tests` directory can be run using this command:
+
+```bash
+$ tox
+```
+
+## Reporting issues
+
+Please submit the issue using the appropiate template provided for a bug report or a feature request:
+
+* [Issues](https://github.com/shivammathur/ippy/issues)

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+github: shivammathur
+patreon: shivammathur
+custom: https://www.paypal.me/shivammathur

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Please provide instruction to reproduce the bug.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,35 @@
+---
+name: |
+  🐞 Failing Test
+  🐞 Bug Fix
+  ⚙ Improvement
+  🎉 New Feature
+about: You found a bug, have a failing test, want to improve something or add a new feature
+labels: bug or enhancement
+---
+
+## A Pull Request should be associated with an Issue.
+
+> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
+> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
+> and potentially we'll be able to point development in a particular direction.
+
+Related issue: 
+
+> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
+> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
+
+### Description
+
+This PR [briefly explain what it does]
+
+> In case this PR introduced code changes:
+
+- [ ] I have written test cases for the changes in this pull request
+- [ ] I have run `tox` before the commit.
+- [ ] `tox` returns with no unit test errors for the version of python installed.
+
+<!--
+- Please target the develop branch when submitting the pull request.
+-->
+-->

.github/PULL_REQUEST_TEMPLATE/FAILING_TEST.md

@@ -0,0 +1,30 @@
+---
+name: 🐞 Failing Test
+about: You found a bug and have a failing test?
+labels: bug
+---
+
+## A Pull Request should be associated with an Issue.
+
+> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
+> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
+> and potentially we'll be able to point development in a particular direction.
+
+Related issue: 
+
+> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
+> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
+
+### Description
+
+This PR [briefly explain what it does]
+
+> In case this PR introduced code changes:
+
+- [ ] I have written test cases for the changes in this pull request
+- [ ] I have run `tox` before the commit.
+- [ ] `tox` returns with no unit test errors for the version of python installed.
+
+<!--
+- Please target the develop branch when submitting the pull request.
+-->

.github/PULL_REQUEST_TEMPLATE/FIX.md

@@ -0,0 +1,30 @@
+---
+name: 🐞 Bug Fix
+about: You have a fix for a bug?
+labels: bug
+---
+
+## A Pull Request should be associated with an Issue.
+
+> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
+> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
+> and potentially we'll be able to point development in a particular direction.
+
+Related issue: 
+
+> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
+> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
+
+### Description
+
+This PR [briefly explain what it does]
+
+> In case this PR introduced code changes:
+
+- [ ] I have written test cases for the changes in this pull request
+- [ ] I have run `tox` before the commit.
+- [ ] `tox` returns with no unit test errors for the version of python installed.
+
+<!--
+- Please target the develop branch when submitting the pull request.
+-->

.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md

@@ -0,0 +1,30 @@
+---
+name: ⚙ Improvement
+about: You have some improvement to make IPpy better?
+labels: enhancement
+---
+
+## A Pull Request should be associated with an Issue.
+
+> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
+> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
+> and potentially we'll be able to point development in a particular direction.
+
+Related issue: 
+
+> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
+> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
+
+### Description
+
+This PR [briefly explain what it does]
+
+> In case this PR introduced code changes:
+
+- [ ] I have written test cases for the changes in this pull request
+- [ ] I have run `tox` before the commit.
+- [ ] `tox` returns with no unit test errors for the version of python installed.
+
+<!--
+- Please target the develop branch when submitting the pull request.
+-->

.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md

@@ -0,0 +1,30 @@
+---
+name: 🎉 New Feature
+about: You have implemented some neat idea that you want to make part of IPpy?
+labels: enhancement
+---
+
+## A Pull Request should be associated with an Issue.
+
+> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
+> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
+> and potentially we'll be able to point development in a particular direction.
+
+Related issue: 
+
+> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
+> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
+
+### Description
+
+This PR [briefly explain what it does]
+
+> In case this PR introduced code changes:
+
+- [ ] I have written test cases for the changes in this pull request
+- [ ] I have run `tox` before the commit.
+- [ ] `tox` returns with no unit test errors for the version of python installed.
+
+<!--
+- Please target the develop branch when submitting the pull request.
+-->