Please read the first section before reporting a bug!
The golden rule is to always open one issue for one bug. If you notice several bugs and want to report them, make sure to create one new issue for each of them.
If you're reporting a new bug, you'll make our life simpler (and the fix will come sooner) by following these guidelines:
Issues are often reported several times by various users. It's good practice to search first in the issue tracker before reporting your issue. If you don't find a relevant match or if you're unsure, don't hesitate to open a new issue. The bugsquad will handle it from there if it's a duplicate.
Rebel Engine runs on a large variety of platforms and operating systems and devices. In your bug reports, please always specify:
- Operating system and version (e.g. Windows 10, macOS 10.15, Ubuntu 19.10)
- Rebel Engine version (e.g. 1.0 or the Git commit hash if you're using a development branch)
For bugs that are likely OS-specific and/or graphics-related, please also specify:
- Device (CPU model including architecture, e.g. x86, x86_64, ARM, etc.)
- GPU model (and the driver version in use if you know it)
Bug reports not including the required information may be closed at the maintainers' discretion. If in doubt, always include all the requested information; it's better to include too much information than not enough information.
Many bugs can't be reproduced unless specific steps are taken. Please specify the exact steps that must be taken to reproduce the condition, and try to keep them as minimal as possible. If you're describing a procedure to follow in the editor, don't hesitate to include screenshots.
Making your bug report easy to reproduce will make it easier for contributors to fix the bug.
Sometimes, unexpected behavior can happen in your project. In such case, understand that:
- What happens to you may not happen to other users.
- We can't take the time to look at your project, understand how it is set up and then figure out why it's failing.
To speed up our work, please upload a minimal project that isolates and reproduces the issue. This is always the best way for us to fix it. We recommend attaching a ZIP file with the minimal project directly to the bug report, by drag and dropping the file in the GitHub edition field. This ensures the file can remain available for a long period of time. Only use third-party file hosts if your ZIP file isn't accepted by GitHub because it's too large.
We recommend always attaching a minimal reproduction project, even if the issue may seem simple to reproduce manually.
If you've been asked by a maintainer to upload a minimal reproduction project, you must do so within 7 days. Otherwise, your bug report will be closed as it'll be considered too difficult to diagnose.
Now that you've read the guidelines, click the link below to create a bug report:
Proposal issues are required to explain in technical detail how the suggested change should be implemented. It is also preferred that the submitter of a proposal is ready to implement it if it was approved.
A valid feature proposal will be held open to allow fellow Rebel Engine users and contributors to weigh in on the suggestion and its implementation. While all opinions are considered, a core developer must approve the feature and its implementation for a proposal to be considered ready to implement.
Proposals should be made by opening an issue or a discussion, not a pull request. Don't fork this repository to open a proposal.
If you want to add new engine features, please make sure that:
- This functionality is desired, which means that it solves a common use case that several users will need in their real-life projects.
- You talked to other developers on how to implement it best. See also Proposing features or improvements.
- Even if it doesn't get merged, your PR is useful for future work by another developer.
Similar rules can be applied when contributing bug fixes - it's always best to discuss the implementation in the bug report first if you are not 100% about what would be the best fix.
In addition to the following tips, also take a look at the Engine development guide for an introduction to developing on Rebel Engine.
The Contributing docs also have important information on the PR workflow and the code style we use.
If your pull request adds methods, properties or signals that are exposed to scripting APIs, you must update the class reference to document those. This is to ensure the documentation coverage doesn't decrease as contributions are merged.
Update the documentation template using your compiled binary, then fill in the descriptions. Follow the style guide described in the Docs writing guidelines.
If your pull request modifies parts of the code in a non-obvious way, make sure
to add comments in the code as well. This helps other people understand the
change without having to look at git blame.
Try to make simple PRs that handle one specific topic. Just like for reporting issues, it's better to open 3 different PRs that each address a different issue than one big PR with three commits.
When updating your fork with upstream changes, please use git pull --rebase
to avoid creating "merge commits". Those commits unnecessarily pollute the git
history when coming from PRs.
Also try to make commits that bring the engine from one stable state to another
stable state, i.e. if your first commit has a bug that you fixed in the second
commit, try to merge them together before making your pull request (see git rebase -i and relevant help about rebasing or amending commits on the
Internet).
This Git style guide has some good practices to have in mind.
See our PR workflow documentation for tips on using Git, amending commits and rebasing branches.
The way you format your commit messages is quite important to ensure that the commit history and changelog will be easy to read and understand. A Git commit message is formatted as a short title (first line) and an extended description (everything after the first line and an empty separation line).
The short title is the most important part, as it is what will appear in the
shortlog changelog (one line per commit, so no description shown) or in the
GitHub interface unless you click the "expand" button. As the name says, try to
keep that first line under 72 characters. It should describe what the commit
does globally, while details would go in the description. Typically, if you
can't keep the title short because you have too much stuff to mention, it means
you should probably split your changes in several commits :)
Here's an example of a well-formatted commit message (note how the extended description is also manually wrapped at 80 chars for readability):
Prevent French fries carbonization by fixing heat regulation
When using the French fries frying module, Rebel would not regulate the heat
and thus bring the oil bath to supercritical liquid conditions, thus causing
unwanted side effects in the physics engine.
By fixing the regulation system via an added binding to the internal feature,
this commit now ensures that Rebel will not go past the ebullition temperature
of cooking oil under normal atmospheric conditions.
Fixes #1789, long live the Realm!
Note: When using the GitHub online editor or its drag-and-drop feature, please edit the commit title to something meaningful. Commits named "Update my_file.cpp" won't be accepted.
Thanks for your interest in contributing!
—The Rebel Engine development team