First of all, I would like to say thank you for contributing to this project! This is my first open-source project that was started as a project in high school. My goal is to have a library that can be used by anyone to create their own card games. But in order to reach this goal, I need you! The community is the backbone to any open-source project that is needed to reach this goal.
- Reporting a bug 🐛
- Discussing the current state of the code 🗣
- Submitting a fix 🛠
- Proposing new features 🚀
- Becoming a maintainer 💪
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
We Use Github Flow, So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:
- Fork the repo and create your branch from
master
. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
Report bugs using GitHub's Issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can. My stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
People love thorough bug reports. I'm not even kidding.
It is preferred to use autopep8 to format your code. This will ensure that your code is consistent and easy to read. Deepsource.io will automatically run checks to ensure that your code is formatted correctly.
By contributing, you agree that your contributions will be licensed under its MIT License.
This document was adapted from briandk's CONTRIBUTING.md template