Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
executable file
·
61 lines (38 loc) · 2.02 KB

CONTRIBUTING.rst

File metadata and controls

executable file
·
61 lines (38 loc) · 2.02 KB

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Reporting & Fixing Bugs

Please report bugs at https://github.com/funkyheatmap/funkyheatmappy/issues and include the following information:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug with a minimal example.

If you want to contribute and fix these bugs, feel free to fork the repository and submit a pull request, or engage in the issue discussion

Implementing extra features

Any issues tagged with "feature" can be implemented by anyone. Feel free to fork the repository and submit a pull request.

If you want an additional feature, feel free to open an issue and we will discuss whether it fits the scope of the package.

Get Started!

Ready to contribute? Here's how to set up funkyheatmappy for local development.

  1. Fork the funkyheatmappy repo on GitHub and clone your fork locally.

  2. Create a branch for local development and make your changes.

    $ git checkout -b name-of-your-bugfix-or-feature

  3. When you're done making changes, check that your changes pass style and unit tests, including testing other Python versions with tox:

    $ tox
  1. Commit your changes and push your branch to GitHub:
  2. 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.rst.