81 lines
2.3 KiB
Markdown
81 lines
2.3 KiB
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
|
||
|
|
|
||
|
|
You can contribute in many ways:
|
||
|
|
|
||
|
|
## Types of Contributions
|
||
|
|
|
||
|
|
### Report Bugs
|
||
|
|
|
||
|
|
Report bugs at https://github.com/elfsternberg/formulaic/issues.
|
||
|
|
|
||
|
|
If you are reporting a bug, please include:
|
||
|
|
|
||
|
|
* Your operating system name and version.
|
||
|
|
* Any details about your local setup that might be helpful in troubleshooting.
|
||
|
|
* Detailed steps to reproduce the bug.
|
||
|
|
|
||
|
|
### Fix Bugs
|
||
|
|
|
||
|
|
Look through the GitHub issues for bugs. Anything tagged with "bug"
|
||
|
|
is open to whoever wants to implement it.
|
||
|
|
|
||
|
|
### Implement Features
|
||
|
|
|
||
|
|
Look through the GitHub issues for features. Anything tagged with "feature"
|
||
|
|
is open to whoever wants to implement it.
|
||
|
|
|
||
|
|
### Write Documentation
|
||
|
|
|
||
|
|
formulaic could always use more documentation, whether as part of the
|
||
|
|
official formulaic docs, in docstrings, or even on the web in blog posts,
|
||
|
|
articles, and such.
|
||
|
|
|
||
|
|
### Submit Feedback
|
||
|
|
|
||
|
|
The best way to send feedback is to file an issue at https://github.com/elfsternberg/formulaic/issues.
|
||
|
|
|
||
|
|
If you are proposing a feature:
|
||
|
|
|
||
|
|
* Explain in detail how it would work.
|
||
|
|
* Keep the scope as narrow as possible, to make it easier to implement.
|
||
|
|
* Remember that this is a volunteer-driven project, and that contributions
|
||
|
|
are welcome :)
|
||
|
|
|
||
|
|
## Get Started!
|
||
|
|
|
||
|
|
Ready to contribute? Here's how to set up `formulaic` for local development.
|
||
|
|
|
||
|
|
1. Fork the `formulaic` repo on GitHub.
|
||
|
|
2. Clone your fork locally::
|
||
|
|
|
||
|
|
$ git clone git@github.com:your_name_here/formulaic.git
|
||
|
|
|
||
|
|
3. Create a branch for local development::
|
||
|
|
|
||
|
|
$ git checkout -b name-of-your-bugfix-or-feature
|
||
|
|
|
||
|
|
Now you can make your changes locally.
|
||
|
|
|
||
|
|
4. When you're done making changes, check that your changes pass the tests::
|
||
|
|
|
||
|
|
$ make test
|
||
|
|
|
||
|
|
6. Commit your changes and push your branch to GitHub::
|
||
|
|
|
||
|
|
$ git add .
|
||
|
|
$ git commit -m "Your detailed description of your changes."
|
||
|
|
$ git push origin name-of-your-bugfix-or-feature
|
||
|
|
|
||
|
|
7. Submit a pull request through the GitHub website.
|
||
|
|
|
||
|
|
Pull Request Guidelines
|
||
|
|
-----------------------
|
||
|
|
|
||
|
|
Before you submit a pull request, check that it meets these guidelines:
|
||
|
|
|
||
|
|
1. The pull request should include tests.
|
||
|
|
2. If the pull request adds functionality, the docs should be updated. Put
|
||
|
|
your new functionality into a function with a docstring, and add the
|
||
|
|
feature to the list in README.md.
|