SpaRcle Engine Contribution Guidelines¶
We love your enthusiasm and interest in the project! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Discussing the project.
- Reporting an issue.
- Proposing new features.
- Maintaining cross-platform, implementing support for a new platform.
Report issues/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!
Development¶
To run & test SpaRcle Engine, you need to follow our docs.
All Changes Happen Through Pull Requests¶
Pull requests are the best way to propose changes. We actively welcome your pull requests:
If you are not sure, create an issue first to discuss the changes you want to make.
- Fork the repo and create your branch from
dev. - Make the changes.
- If you've changed APIs, update the documentation.
- Make the PR!
Any contributions you make will be under the MIT Software License¶
In short, when you submit 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.
Bug Reports¶
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- What actually happens
- What you expected would happen
- 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.
Feature Request¶
Great Feature Requests tend to have:
- A quick idea summary
- What & why do you want to add the specific feature
- Additional context like images, links to resources to implement the feature, etc.