Andrew/redot-engine
1
0
Fork 0
mirror of https://github.com/Redot-Engine/redot-engine.git synced 2025-12-05 23:07:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated CONTRIBUTING.md w/ PR Guideline and Redot Docs links

Browse Source
This commit is contained in:
Skogi
2024-10-16 01:51:03 -07:00
parent f3014b49c7
commit e747f9a244
1 changed files with 33 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
CONTRIBUTING.md
View File

@@ -3,7 +3,7 @@
This document summarizes the most important points for people interested in This document summarizes the most important points for people interested in
contributing to Redot, especially via bug reports or pull requests. contributing to Redot, especially via bug reports or pull requests.
The [Redot Discord](https://discord.gg/redot) documentation has a dedicated Contributing section The [Redot Documentation](https://docs-stable.redotengine.org/contributing/development) has a dedicated Contributing section
which details these points and more, and is a recommended read. which details these points and more, and is a recommended read.
## Table of contents ## Table of contents
@@ -11,11 +11,16 @@ which details these points and more, and is a recommended read.
- [Reporting bugs](#reporting-bugs) - [Reporting bugs](#reporting-bugs)
- [Proposing features or improvements](#proposing-features-or-improvements) - [Proposing features or improvements](#proposing-features-or-improvements)
- [Contributing pull requests](#contributing-pull-requests) - [Contributing pull requests](#contributing-pull-requests)
- [Contributing to Godot translations](#contributing-to-godot-translations) - [Contributing to Redot translations](#contributing-to-redot-translations)
- [Communicating with developers](#communicating-with-developers) - [Communicating with developers](#communicating-with-developers)
## Reporting bugs ## Reporting bugs
If you are reporting a bug with an unstable development build, it helps us greatly
if you open your project in Godot's current dev builds to ensure that it is not
a bug we've inherited from their upstream work process, as we must let them
work on those bugs to minimize merge conflicts on our end.
Report bugs [here](https://github.com/Redot-Engine/redot-engine/issues/new?assignees=&labels=&template=bug_report.yml). Report bugs [here](https://github.com/Redot-Engine/redot-engine/issues/new?assignees=&labels=&template=bug_report.yml).
Please follow the instructions in the template when you do. Please follow the instructions in the template when you do.
@@ -25,7 +30,8 @@ Be sure to not include the `.godot` folder in the archive to save space.
Make sure that the bug you are experiencing is reproducible in the latest Redot Make sure that the bug you are experiencing is reproducible in the latest Redot
releases. It's worth testing against both the latest stable release and the releases. It's worth testing against both the latest stable release and the
latest dev snapshot for the next Redot release. latest dev snapshot for the next Redot release, as well as the latest Godot
dev snapshot.
If you run into a bug which wasn't present in an earlier Redot version (what we If you run into a bug which wasn't present in an earlier Redot version (what we
call a _regression_), please mention it and clarify which versions you tested call a _regression_), please mention it and clarify which versions you tested
@@ -35,10 +41,21 @@ call a _regression_), please mention it and clarify which versions you tested
**The main issue tracker is for bug reports and does not accept feature proposals.** **The main issue tracker is for bug reports and does not accept feature proposals.**
Instead, head to the [Redot Discord](https://discord.gg/redot). Visit the [Redot Proposals Repo](https://github.com/Redot-Engine/redot-proposals)
to suggest features or improvements to the engine.
## Contributing pull requests ## Contributing pull requests
Please refer to these links for detailed guides on workflow:
(credit to Godot for these fantastic workflow guides)
- [Code Style](https://docs.redotengine.org/en/stable/contributing/development/code_style_guidelines.html)
- [PR Workflow](https://docs.redotengine.org/en/latest/contributing/workflow/pr_workflow.html)
- [PR Review](https://docs.redotengine.org/en/latest/contributing/workflow/pr_review_guidelines.html)
Additionally, we expect all PR contributors to be using [Pre-Commit](https://pre-commit.com/) to
speed up PR workflow. See the Code Style doc above for more information.
If you want to add new engine features, please make sure that: 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 - This functionality is desired, which means that it solves a common use case
@@ -52,7 +69,8 @@ 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 discuss the implementation in the bug report first if you are not 100% about
what would be the best fix. what would be the best fix.
Visit the [Redot Discord](https://discord.gg/redot) for information and guides related to contribution and pull requests. Read the [Redot Documentation](https://docs-stable.redotengine.org/contributing/development)
for information and guides related to contribution and pull requests.
### Be mindful of your commits ### Be mindful of your commits
@@ -128,10 +146,10 @@ scripting APIs, you **must** update the class reference to document those.
This is to ensure the documentation coverage doesn't decrease as contributions This is to ensure the documentation coverage doesn't decrease as contributions
are merged. are merged.
[Update documentation XML files](https://docs.godotengine.org/en/latest/contributing/documentation/updating_the_class_reference.html) [Update documentation XML files](https://docs.redotengine.org/en/latest/contributing/documentation/updating_the_class_reference.html)
using your compiled binary, then fill in the descriptions. using your compiled binary, then fill in the descriptions.
Follow the style guide described in the Follow the style guide described in the
[Documentation writing guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/docs_writing_guidelines.html). [Documentation writing guidelines](https://docs.redotengine.org/en/latest/contributing/documentation/docs_writing_guidelines.html).
If your pull request modifies parts of the code in a non-obvious way, make sure 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 to add comments in the code as well. This helps other people understand the
@@ -157,15 +175,15 @@ applicable.
Feel free to contribute standalone pull requests to add new tests or improve Feel free to contribute standalone pull requests to add new tests or improve
existing tests as well. existing tests as well.
See [Unit testing](https://docs.godotengine.org/en/latest/contributing/development/core_and_modules/unit_testing.html) See [Unit testing](https://docs.redotengine.org/en/latest/contributing/development/core_and_modules/unit_testing.html)
for information on writing tests in Godot's C++ codebase. for information on writing tests in Redot's C++ codebase.
## Contributing to Godot translations ## Contributing to Redot translations
You can contribute to Godot translations on [Hosted Weblate](https://hosted.weblate.org/projects/godot-engine/), You can contribute to Redot translations by leaving a volunteer application
an open source and web-based translation platform. on the [Redot Discord](https://discord.gg/redot) for us to review.
Please refer to Godot's [editor and documentation localization guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/editor_and_docs_localization.html) Please refer to Redot's [editor and documentation localization guidelines](https://docs.redotengine.org/en/latest/contributing/documentation/editor_and_docs_localization.html)
for an overview of the translation resources and what they correspond to. for an overview of the translation resources and what they correspond to.
## Communicating with developers ## Communicating with developers
@@ -180,7 +198,8 @@ or a bug you want to fix), the following channels can be used:
existing issue about a topic you want to discuss, you can participate directly. existing issue about a topic you want to discuss, you can participate directly.
If not, you can open a new issue. Please mind the guidelines outlined above If not, you can open a new issue. Please mind the guidelines outlined above
for bug reporting. for bug reporting.
- Feature Proposals should be made on the [Redot Discord](https://discord.gg/redot) for now. - [Redot Proposals Repo](https://github.com/Redot-Engine/redot-proposals): Feature
or improvement proposals.
- [Redot](https://x.com/redotengine) on Twitter - [Redot](https://x.com/redotengine) on Twitter
Thanks for your interest in contributing! Thanks for your interest in contributing!