.. highlight:: shell
============ 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:
Report Bugs ~~~~~~~~~~~
Report bugs at https://github.com/UBC-MDS/ploteasyr/issues.
If you are reporting a bug, please include:
Fix Bugs ~~~~~~~~
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Implement Features ~~~~~~~~~~~~~~~~~~
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Write Documentation ~~~~~~~~~~~~~~~~~~~
ploteasy could always use more documentation, whether as part of the official ploteasy 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 athttps://github.com/UBC-MDS/ploteasyr/issues.
If you are proposing a feature:
Ready to contribute? Here’s how to set up ploteasy
for local development.
Fork the ploteasy
repo on GitHub.
Clone your fork locally::
$ git clone git@github.com:your_name_here/ploteasy.git
Install your local copy (it is recommended to do this with a virtual environment). The method of installation will depend on the packaging library being used. For example, if setuptools
is being used (a setup.py file is present), install ploteasy with:
.. code-block:: console
$ python setup.py install
If poetry
is being used (poetry.lock and pyproject.toml files are present), install ploteasy with:
.. code-block:: console
$ poetry install
Create a branch for local development and make your changes locally::
$ git checkout -b name-of-your-bugfix-or-feature
When you’re done making changes, check that your changes conform to any code formatting requirements and pass any tests. For example, if the package uses the poetry package management library, black formatting style and pytest for testing::
$ poetry run black ploteasy $ poetry run pytest
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
Submit a pull request through the GitHub website.
Before you submit a pull request, check that it meets these guidelines: