CONTRIBUTING.md

In UBC-MDS/Rgroup12: Image processing

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/UBC-MDS/Rgroup12/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" 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

Rgroup12 could always use more documentation, whether as part of the official Rgroup12 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/UBC-MDS/Rgroup12/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 Rgroup12 for local development.

1. Fork the Rgroup12 repo on GitHub.

2. Clone your fork locally:

   git clone https://github.com/UBC-MDS/Rgroup12.git

3. Install your local copy with Poetry, this is how you set up your fork for local development:

   cd Rgroup12 poetry install

4. Create a branch for local development:

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

   Now you can make your changes locally.

5. When you're done making changes, check that your changes pass the tests by running pytest

   poetry run pytest

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.
3. The pull request should work for Python 3.7 & 3.8. Check https://github.com/UBC-MDS/Rgroup12/pulls and make sure that the tests pass for all supported R versions.

Tips

To run a subset of tests:

check()

Deploying

A reminder for the maintainers on how to deploy:

• Ensure the following secrets are recorded on GitHub:
  • CODECOV_TOKEN
  • PYPI_USERNAME
  • PYPI_PASSWORD

GitHub Actions should build and deploy to testPyPI when a pull request is merged into master.

Code of Conduct

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

UBC-MDS/Rgroup12 documentation built on April 1, 2020, 4:36 a.m.