SpaRcle Engine Contribution Guidelines.
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting an issue.
- Discussing the current state of the code.
- Submitting a fix.
- Proposing new features.
- Maintaining cross-platform, implementing support for a new platform.
Pull requests are the best way to propose changes. We actively welcome your pull requests:
- Fork the repo and create your branch from
dev. - If you've added code that should be tested, add some tests' examples.
- If you've changed APIs, update the documentation.
- Issue that pull request!
To run & test SpaRcle Engine, you need to follow a few simple steps from our README.md
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.
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!
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.
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.