Skip to content

Commit be3fc26

Browse files
aaronreidsmithaaronreidsmith
authored
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
1 parent cc5a8e4 commit be3fc26

File tree

10 files changed

+338
-36
lines changed

10 files changed

+338
-36
lines changed

‎.github/CONTRIBUTING.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
<!-- Adapted from Atom's CONTRIBUTING.md file: https://github.com/atom/atom/blob/master/CONTRIBUTING.md -->
2+
# Contributing to `pmdarima`
3+
4+
First off, thanks for taking the time to contribute!
5+
6+
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.
7+
8+
#### Table Of Contents
9+
10+
[Resources](#resources)
11+
12+
[How Can I Contribute?](#how-can-i-contribute)
13+
* [Filing Issues](#filing-issues)
14+
* [Filing A Bug](#filing-a-bug)
15+
* [Filing A Feature Request](#filing-a-feature-request)
16+
17+
* [Contributing Code](#contributing-code)
18+
* [First Time Contributor?](#first-time-contributor)
19+
* [Developing Locally](#developing-locally)
20+
* [Pull Requests](#pull-requests)
21+
22+
## Resources
23+
24+
[Official Documentation](https://www.alkaline-ml.com/pmdarima/)
25+
[Issue Tracker](https://github.com/tgsmith61591/pmdarima/issues)
26+
27+
## How Can I Contribute?
28+
29+
### Filing Issues
30+
31+
#### Filing A Bug
32+
33+
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
34+
35+
> **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.
36+
37+
##### How Do I Submit A _Good_ Bug Report?
38+
39+
Explain the problem and include additional details to help maintainers reproduce the problem:
40+
41+
* **Use a clear and descriptive title** for the issue to identify the problem.
42+
* **Describe the exact steps which reproduce the problem** in as many details as possible.
43+
* **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).
44+
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
45+
* **Explain which behavior you expected to see instead and why.**
46+
47+
#### Filing A Feature Request
48+
49+
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
50+
51+
### Contributing Code
52+
53+
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.
54+
55+
#### First Time contributor?
56+
Start by looking for the `help wanted` or `good first issue` tags to help you dive in.
57+
58+
#### Developing Locally
59+
* To build `pmdarima` from source, you will require `cython>=0.29` and `gcc` (Mac/Linux) or `MinGW` (Windows).
60+
* _Always_ use a feature branch
61+
* Be sure to add tests for any new functionality you create
62+
* Make sure your change doesn't break anything else by running the test suite using one of the following:
63+
64+
```bash
65+
$ make test
66+
```
67+
68+
or
69+
70+
```bash
71+
$ python setup.py develop
72+
$ pytest
73+
```
74+
75+
#### Pull Requests
76+
77+
The process described here has several goals:
78+
79+
* Maintain `pmdarima`'s quality
80+
* Fix problems that are important to users
81+
* Engage the community in working toward the best possible `pmdarima`
82+
* Enable a sustainable system for `pmdarima`'s maintainers to review contributions
83+
84+
Please follow these steps to have your contribution considered by the maintainers:
85+
86+
1. Follow all instructions in [the template](PULL_REQUEST_TEMPLATE.md)
87+
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>
88+
89+
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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve pmdarima
4+
title: ''
5+
labels: ":beetle: : bug"
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
<!-- A clear and concise description of what the bug is. -->
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
16+
```python
17+
<YOUR CODE HERE>
18+
```
19+
20+
**Versions**
21+
<!--
22+
Please run the following snippet and paste the output below.
23+
import platform; print(platform.platform())
24+
import sys; print("Python", sys.version)
25+
import pmdarima; print("pmdarima", pmdarima.__version__)
26+
import numpy; print("NumPy", numpy.__version__)
27+
import scipy; print("SciPy", scipy.__version__)
28+
import sklearn; print("Scikit-Learn", sklearn.__version__)
29+
import statsmodels; print("Statsmodels", statsmodels.__version__)
30+
-->
31+
32+
**Expected behavior**
33+
<!-- A clear and concise description of what you expected to happen. -->
34+
35+
**Actual behavior**
36+
<!-- A clear and concise description of what actually happened -->
37+
38+
**Additional context**
39+
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for pmdarima
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
12+
13+
**Describe the solution you'd like**
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
**Describe alternatives you've considered**
17+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
18+
19+
**Additional context**
20+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/QUESTION.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Question
3+
about: Ask a question about pmdarima
4+
title: ''
5+
labels: ":grey_question: : question"
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Before asking a question, please consult our closed issues and docs to see
11+
if we have already addressed it:
12+
13+
https://github.com/tgsmith61591/pmdarima/issues?q=is%3Aissue+is%3Aclosed
14+
https://www.alkaline-ml.com/pmdarima/
15+
-->
16+
17+
**Question**
18+
<!-- A clear and concise description of the issue you're experiencing, and under what conditions -->
19+
20+
**Versions (if necessary)**
21+
<!--
22+
Please run the following snippet and paste the output below.
23+
import platform; print(platform.platform())
24+
import sys; print("Python", sys.version)
25+
import pmdarima; print("pmdarima", pmdarima.__version__)
26+
import numpy; print("NumPy", numpy.__version__)
27+
import scipy; print("SciPy", scipy.__version__)
28+
import sklearn; print("Scikit-Learn", sklearn.__version__)
29+
import statsmodels; print("Statsmodels", statsmodels.__version__)
30+
-->

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!-- Please prefix your title with one of the following:
2+
3+
[WIP] - If the pull request is not finalized
4+
[MRG] - If you are ready to have this PR looked at by a project maintainer
5+
6+
-->
7+
8+
# Description
9+
10+
Please include a summary of the change and which issue is fixed.
11+
Please also include relevant motivation and context. List any dependencies
12+
that are required for this change.
13+
14+
Fixes #(issue)
15+
16+
## Type of change
17+
18+
Please delete options that are not relevant.
19+
20+
- [ ] Bug fix (non-breaking change which fixes an issue)
21+
- [ ] New feature (non-breaking change which adds functionality)
22+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
23+
- [ ] Documentation change
24+
25+
# How Has This Been Tested?
26+
27+
Please describe the tests that you ran to verify your changes.
28+
Provide instructions so we can reproduce. Please also list any relevant details
29+
for your test configuration
30+
31+
- [ ] Test A
32+
- [ ] Test B
33+
34+
# Checklist:
35+
36+
- [ ] I have performed a self-review of my own code
37+
- [ ] I have commented my code, particularly in hard-to-understand areas
38+
- [ ] I have made corresponding changes to the documentation
39+
- [ ] My changes generate no new warnings
40+
- [ ] I have added tests that prove my fix is effective or that my feature works
41+
- [ ] New and existing unit tests pass locally with my changes

‎CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at <[email protected]>. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎ISSUE_TEMPLATE.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎doc/citing.rst

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. _citing:
2+
3+
======
4+
Citing
5+
======
6+
7+
If you would like to include ``pmdarima`` in your published work, please cite it as follows:
8+
9+
.. raw:: html
10+
11+
<ul>
12+
<li>Smith, Taylor G., <i>et al.</i> pmdarima: ARIMA estimators for Python, 2017-,
13+
<a href=http://www.alkaline-ml.com/pmdarima target="_blank">http://www.alkaline-ml.com/pmdarima</a>
14+
[Online; accessed
15+
16+
<!-- So we can have the current date in the pre-written citation -->
17+
<script type="text/javascript">
18+
var today = new Date();
19+
var formattedDate = [
20+
today.getFullYear(),
21+
('0' + (today.getMonth() + 1)).slice(-2),
22+
('0' + today.getDate()).slice(-2),
23+
].join('-');
24+
document.write(formattedDate);
25+
document.write('].'); // Easier to just put this in the script tag
26+
</script>
27+
28+
</li>
29+
</ul>
30+
31+
BibTeX Entry:
32+
33+
.. code-block:: tex
34+
35+
@MISC {pmdarima,
36+
author = {Taylor G. Smith and others},
37+
title = {{pmdarima}: ARIMA estimators for {Python}},
38+
year = {2017--},
39+
url = "http://www.alkaline-ml.com/pmdarima",
40+
note = {[Online; accessed <today>]}
41+
}

‎doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Helpful sections to get started:
3636
* :ref:`api_ref`
3737
* :ref:`contrib`
3838
* :ref:`contributors`
39+
* :ref:`citing`
3940
* :ref:`quickstart`
4041
* :ref:`user_guide`
4142

‎doc/user_guide.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ contribute you'll need to be able to build from source.
2828
usecases.rst
2929
contributing.rst
3030
contributors.rst
31+
citing.rst
3132

3233
.. raw:: html
3334

0 commit comments

Comments
 (0)