Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

79 lines (53 loc) · 2.12 KB
editor_options
markdown
wrap
72

Contributing

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

Types of Contributions

Report Bugs

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" 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

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

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 pymine for local development.

  1. Fork the package

  2. Install the development dependencies (you can use devtools::install_dev_deps())

  3. Commit your changes to the branch you made with an appropriate message

  4. Push your changes into the remote Git Repository and create a pull request

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include additional tests if appropriate.
  2. Create a branch to add your contributions
  3. If the pull request adds functionality, the docs should be updated.
  4. The pull request should work for all currently supported operating systems and versions of Rstudio.

Code of Conduct

Please note that the Brokr project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.