First off, thank you for considering contributing to Platfuse Game Engine! It's people like you that make Platfuse such a great tool for game developers.
This project and everyone participating in it is governed by the Platfuse Code of Conduct. By participating, you are expected to uphold this code.
This section guides you through submitting a bug report for Platfuse. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before Submitting A Bug Report
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
This section guides you through submitting an enhancement suggestion for Platfuse, including completely new features and minor improvements to existing functionality.
Before Submitting An Enhancement Suggestion
- Check if the enhancement has already been suggested or implemented.
- Clearly describe the suggestion with as much detail as possible, and include examples if applicable.
Unsure where to begin contributing to Platfuse? You can start by looking through these beginner
and help-wanted
issues:
- Beginner issues - issues which should only require a few lines of code, and a test or two.
- Help wanted issues - issues which should be a bit more involved than
beginner
issues.
- Do not include issue numbers in the PR title
- Include screenshots and animated GIFs in your pull request whenever possible.
- Follow the TypeScript style guide.
- Document new code based on the JSDoc style.
- End all files with a newline.
All TypeScript must adhere to TypeScript Style Guide.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
This section lists the labels we use to help us track and manage issues and pull requests.
bug
: A bugenhancement
: Feature requestsdocumentation
: Improvements or additions to documentationbeginner
: Good first issues for newcomers
By contributing to Platfuse, you agree that your contributions will be licensed under its MIT License.