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 at https://github.com/UBC-MDS/Rgroup12/issues.
If you are reporting a bug, please include:
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
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.
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:
Ready to contribute? Here's how to set up
Rgroup12 for local development.
Rgroup12 repo on GitHub.
Clone your fork locally:
git clone https://github.com/UBC-MDS/Rgroup12.git
Install your local copy with Poetry, this is how you set up your fork for local development:
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you're done making changes, check that your changes pass the tests by running pytest
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:
To run a subset of tests:
A reminder for the maintainers on how to deploy:
GitHub Actions should build and deploy to testPyPI when a pull request is merged into master.
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.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.