Add documentation for contributors (alkaline-ml#161)

* Added first portion of citation

* Cleaned up bibtex

* Removed tex pygment

* Cleaned up citing.rst

* Added code of conduct

* Updated email address

* Made .github directory

* Moved CODE_OF_CONDUCT to root

* Added new issue templates

* Added issue templates

* Deleted old issue template

* Started on CONTRIBUTING.md

* Added PULL_REQUEST_TEMPLATE

* Added first portion of citation

* Cleaned up bibtex

* Removed tex pygment

* Cleaned up citing.rst

* Added code of conduct

* Updated email address

* Made .github directory

* Moved CODE_OF_CONDUCT to root

* Added new issue templates

* Added issue templates

* Deleted old issue template

* Started on CONTRIBUTING.md

* Added PULL_REQUEST_TEMPLATE

* Added space

* Added QUESTION.md

* Added more to CONTRIBUTING

* Added breaking line in CONTRIBUTING

* Fixed table of contents

* Added content to PULL_REQUEST_TEMPLATE

* Added another checklist option

* Added citing to toctree

.github/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+<!-- Adapted from Atom's CONTRIBUTING.md file: https://github.com/atom/atom/blob/master/CONTRIBUTING.md -->
+# Contributing to `pmdarima`
+
+First off, thanks for taking the time to contribute!
+
+The following is a set of guidelines for contributing to pmdarima. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+#### Table Of Contents
+
+[Resources](#resources)
+
+[How Can I Contribute?](#how-can-i-contribute)  
+  * [Filing Issues](#filing-issues)  
+    * [Filing A Bug](#filing-a-bug)  
+    * [Filing A Feature Request](#filing-a-feature-request)  
+
+  * [Contributing Code](#contributing-code)  
+    * [First Time Contributor?](#first-time-contributor)  
+    * [Developing Locally](#developing-locally)  
+    * [Pull Requests](#pull-requests)
+
+## Resources
+
+[Official Documentation](https://www.alkaline-ml.com/pmdarima/)  
+[Issue Tracker](https://github.com/tgsmith61591/pmdarima/issues)
+
+## How Can I Contribute?
+
+### Filing Issues
+
+#### Filing A Bug
+
+Fill out the [required template](https://github.com/tgsmith61591/pmdarima/issues/new?assignees=&labels=%3Abeetle%3A+%3A+bug&template=BUG_REPORT.md&title=), the information it asks us for helps us resolve issues faster
+
+> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
+
+##### How Do I Submit A _Good_ Bug Report?
+
+Explain the problem and include additional details to help maintainers reproduce the problem:
+
+* **Use a clear and descriptive title** for the issue to identify the problem.
+* **Describe the exact steps which reproduce the problem** in as many details as possible.
+* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
+* **Explain which behavior you expected to see instead and why.**
+
+#### Filing A Feature Request
+
+Fill out the [required template](https://github.com/tgsmith61591/pmdarima/issues/new?assignees=&labels=&template=FEATURE_REQUEST.md&title=), the information it asks us for helps us resolve issues faster
+
+### Contributing Code
+
+There are only a handful of core contributors to the `pmdarima` project, so any help is appreciated! See our [official docs](https://www.alkaline-ml.com/pmdarima/contributing.html#how-to-contribute) for more detailed instructions on how to fork and clone the repo.
+
+#### First Time contributor? 
+Start by looking for the `help wanted` or `good first issue` tags to help you dive in.
+
+#### Developing Locally
+* To build `pmdarima` from source, you will require `cython>=0.29` and `gcc` (Mac/Linux) or `MinGW` (Windows).
+* _Always_ use a feature branch
+* Be sure to add tests for any new functionality you create
+* Make sure your change doesn't break anything else by running the test suite using one of the following:
+
+```bash
+$ make test
+```
+
+or  
+
+```bash
+$ python setup.py develop
+$ pytest
+```
+
+#### Pull Requests
+
+The process described here has several goals:
+
+* Maintain `pmdarima`'s quality
+* Fix problems that are important to users
+* Engage the community in working toward the best possible `pmdarima`
+* Enable a sustainable system for `pmdarima`'s maintainers to review contributions
+
+Please follow these steps to have your contribution considered by the maintainers:
+
+1. Follow all instructions in [the template](PULL_REQUEST_TEMPLATE.md)
+2. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>
+
+While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Create a bug report to help us improve pmdarima
+title: ''
+labels: ":beetle: : bug"
+assignees: ''
+
+---
+
+**Describe the bug**
+<!-- A clear and concise description of what the bug is. -->
+
+**To Reproduce**  
+Steps to reproduce the behavior:
+
+```python
+<YOUR CODE HERE>
+```
+
+**Versions**
+<!--
+Please run the following snippet and paste the output below.
+import platform; print(platform.platform())
+import sys; print("Python", sys.version)
+import pmdarima; print("pmdarima", pmdarima.__version__)
+import numpy; print("NumPy", numpy.__version__)
+import scipy; print("SciPy", scipy.__version__)
+import sklearn; print("Scikit-Learn", sklearn.__version__)
+import statsmodels; print("Statsmodels", statsmodels.__version__)
+-->
+
+**Expected behavior**
+<!-- A clear and concise description of what you expected to happen. -->
+
+**Actual behavior**
+<!-- A clear and concise description of what actually happened -->
+
+**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 pmdarima
+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/ISSUE_TEMPLATE/QUESTION.md

@@ -0,0 +1,30 @@
+---
+name: Question
+about: Ask a question about pmdarima
+title: ''
+labels: ":grey_question: : question"
+assignees: ''
+
+---
+
+<!-- Before asking a question, please consult our closed issues and docs to see
+if we have already addressed it:
+
+https://github.com/tgsmith61591/pmdarima/issues?q=is%3Aissue+is%3Aclosed
+https://www.alkaline-ml.com/pmdarima/
+-->
+
+**Question**
+<!-- A clear and concise description of the issue you're experiencing, and under what conditions -->
+
+**Versions (if necessary)**
+<!--
+Please run the following snippet and paste the output below.
+import platform; print(platform.platform())
+import sys; print("Python", sys.version)
+import pmdarima; print("pmdarima", pmdarima.__version__)
+import numpy; print("NumPy", numpy.__version__)
+import scipy; print("SciPy", scipy.__version__)
+import sklearn; print("Scikit-Learn", sklearn.__version__)
+import statsmodels; print("Statsmodels", statsmodels.__version__)
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,41 @@
+<!-- Please prefix your title with one of the following:
+
+[WIP] - If the pull request is not finalized
+[MRG] - If you are ready to have this PR looked at by a project maintainer
+
+-->
+
+# Description
+
+Please include a summary of the change and which issue is fixed.
+Please also include relevant motivation and context. List any dependencies
+that are required for this change.
+
+Fixes #(issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation change
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes.
+Provide instructions so we can reproduce. Please also list any relevant details
+for your test configuration
+
+- [ ] Test A
+- [ ] Test B
+
+# Checklist:
+
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes

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 within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+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 <[email protected]>. 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

doc/citing.rst

@@ -0,0 +1,41 @@
+.. _citing:
+
+======
+Citing
+======
+
+If you would like to include ``pmdarima`` in your published work, please cite it as follows:
+
+.. raw:: html
+
+    <ul>
+      <li>Smith, Taylor G., <i>et al.</i> pmdarima: ARIMA estimators for Python, 2017-,
+      <a href=http://www.alkaline-ml.com/pmdarima target="_blank">http://www.alkaline-ml.com/pmdarima</a>
+      [Online; accessed
+
+      <!-- So we can have the current date in the pre-written citation -->
+        <script type="text/javascript">
+          var today = new Date();
+          var formattedDate = [
+            today.getFullYear(),
+            ('0' + (today.getMonth() + 1)).slice(-2),
+            ('0' + today.getDate()).slice(-2),
+          ].join('-');
+          document.write(formattedDate);
+          document.write('].'); // Easier to just put this in the script tag
+        </script>
+
+      </li>
+    </ul>
+
+BibTeX Entry:
+
+.. code-block:: tex
+
+    @MISC {pmdarima,
+      author = {Taylor G. Smith and others},
+      title  = {{pmdarima}: ARIMA estimators for {Python}},
+      year   = {2017--},
+      url    = "http://www.alkaline-ml.com/pmdarima",
+      note   = {[Online; accessed <today>]}
+    }

doc/index.rst

@@ -36,6 +36,7 @@ Helpful sections to get started:
 * :ref:`api_ref`
 * :ref:`contrib`
 * :ref:`contributors`
+* :ref:`citing`
 * :ref:`quickstart`
 * :ref:`user_guide`
 

doc/user_guide.rst

@@ -28,6 +28,7 @@ contribute you'll need to be able to build from source.
    usecases.rst
    contributing.rst
    contributors.rst
+   citing.rst
 
 .. raw:: html