mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-11-21 16:37:20 +01:00
Updated the links in CONTRIBUTING.md, also small tweaks.
This commit is contained in:
parent
39045a915e
commit
eac2d9153f
@ -5,8 +5,6 @@
|
|||||||
- [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's translation](#contributing-to-godots-translation)
|
|
||||||
- [Communicating with developers](#communicating-with-developers)
|
|
||||||
|
|
||||||
**Please read the first section before reporting a bug!**
|
**Please read the first section before reporting a bug!**
|
||||||
|
|
||||||
@ -29,11 +27,11 @@ from there if it's a duplicate.
|
|||||||
|
|
||||||
### Specify the platform
|
### Specify the platform
|
||||||
|
|
||||||
Godot runs on a large variety of platforms and operating systems and devices.
|
Pandemonium runs on a large variety of platforms and operating systems and devices.
|
||||||
**In your bug reports, please always specify:**
|
**In your bug reports, please always specify:**
|
||||||
|
|
||||||
- Operating system and version (e.g. Windows 10, macOS 10.15, Ubuntu 19.10)
|
- Operating system and version (e.g. Windows 10, macOS 10.15, Ubuntu 19.10)
|
||||||
- Godot version (e.g. 3.2, 3.1.2, or the Git commit hash if you're using a development branch)
|
- Pandemonium version (e.g. 3.2, 3.1.2, 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:
|
For bugs that are likely OS-specific and/or graphics-related, please also specify:
|
||||||
|
|
||||||
@ -81,18 +79,7 @@ it'll be considered too difficult to diagnose.
|
|||||||
Now that you've read the guidelines, click the link below to create a
|
Now that you've read the guidelines, click the link below to create a
|
||||||
bug report:
|
bug report:
|
||||||
|
|
||||||
- **[Report a bug](https://github.com/godotengine/godot/issues/new?assignees=&labels=&template=bug_report.yml)**
|
- **[Report a bug](https://github.com/Relintai/pandemonium_engine/issues/new)**
|
||||||
|
|
||||||
## Proposing features or improvements
|
|
||||||
|
|
||||||
**Since August 2019, the main issue tracker no longer accepts feature proposals.**
|
|
||||||
Instead, head to the [Godot Proposals repository](https://github.com/godotengine/godot-proposals)
|
|
||||||
and follow the instructions in the README file. High-quality feature proposals
|
|
||||||
are more likely to be well-received by the maintainers and community, so do
|
|
||||||
your best :)
|
|
||||||
|
|
||||||
See [this article](https://godotengine.org/article/introducing-godot-proposals-repository)
|
|
||||||
for detailed rationale on this change.
|
|
||||||
|
|
||||||
## Contributing pull requests
|
## Contributing pull requests
|
||||||
|
|
||||||
@ -115,10 +102,10 @@ recommend that you have a look at it to know what's important to take into
|
|||||||
account for a PR to be considered for merging.
|
account for a PR to be considered for merging.
|
||||||
|
|
||||||
In addition to the following tips, also take a look at the
|
In addition to the following tips, also take a look at the
|
||||||
[Engine development guide](https://docs.godotengine.org/en/latest/development/cpp/)
|
[Engine development guide](https://github.com/Relintai/pandemonium_engine_docs/tree/master/05_engine_development/02_cpp)
|
||||||
for an introduction to developing on Godot.
|
for an introduction to developing on Pandemonium.
|
||||||
|
|
||||||
The [Contributing docs](https://docs.godotengine.org/en/latest/community/contributing/index.html)
|
The [Contributing docs](https://github.com/Relintai/pandemonium_engine_docs/tree/master/06_community/contributing)
|
||||||
also have important information on the PR workflow and the code style we use.
|
also have important information on the PR workflow and the code style we use.
|
||||||
|
|
||||||
### Document your changes
|
### Document your changes
|
||||||
@ -128,10 +115,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 the documentation template](https://docs.godotengine.org/en/latest/community/contributing/updating_the_class_reference.html#updating-the-documentation-template)
|
[Update the documentation template](https://github.com/Relintai/pandemonium_engine_docs/blob/master/06_community/contributing/12_updating_the_class_reference.md)
|
||||||
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
|
||||||
[Docs writing guidelines](https://docs.godotengine.org/en/latest/community/contributing/docs_writing_guidelines.html).
|
[Docs writing guidelines](https://github.com/Relintai/pandemonium_engine_docs/blob/master/06_community/contributing/16_docs_writing_guidelines.md).
|
||||||
|
|
||||||
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
|
||||||
@ -156,7 +143,7 @@ Internet).
|
|||||||
This [Git style guide](https://github.com/agis-/git-style-guide) has some
|
This [Git style guide](https://github.com/agis-/git-style-guide) has some
|
||||||
good practices to have in mind.
|
good practices to have in mind.
|
||||||
|
|
||||||
See our [PR workflow](https://docs.godotengine.org/en/latest/community/contributing/pr_workflow.html)
|
See our [PR workflow](https://github.com/Relintai/pandemonium_engine_docs/blob/master/06_community/contributing/04_pr_workflow.md)
|
||||||
documentation for tips on using Git, amending commits and rebasing branches.
|
documentation for tips on using Git, amending commits and rebasing branches.
|
||||||
|
|
||||||
### Format your commit messages with readability in mind
|
### Format your commit messages with readability in mind
|
||||||
@ -180,12 +167,12 @@ description is also manually wrapped at 80 chars for readability):
|
|||||||
```text
|
```text
|
||||||
Prevent French fries carbonization by fixing heat regulation
|
Prevent French fries carbonization by fixing heat regulation
|
||||||
|
|
||||||
When using the French fries frying module, Godot would not regulate the heat
|
When using the French fries frying module, Pandemonium would not regulate the heat
|
||||||
and thus bring the oil bath to supercritical liquid conditions, thus causing
|
and thus bring the oil bath to supercritical liquid conditions, thus causing
|
||||||
unwanted side effects in the physics engine.
|
unwanted side effects in the physics engine.
|
||||||
|
|
||||||
By fixing the regulation system via an added binding to the internal feature,
|
By fixing the regulation system via an added binding to the internal feature,
|
||||||
this commit now ensures that Godot will not go past the ebullition temperature
|
this commit now ensures that Pandemonium will not go past the ebullition temperature
|
||||||
of cooking oil under normal atmospheric conditions.
|
of cooking oil under normal atmospheric conditions.
|
||||||
|
|
||||||
Fixes #1789, long live the Realm!
|
Fixes #1789, long live the Realm!
|
||||||
@ -195,42 +182,3 @@ Fixes #1789, long live the Realm!
|
|||||||
feature, *please* edit the commit title to something meaningful. Commits named
|
feature, *please* edit the commit title to something meaningful. Commits named
|
||||||
"Update my_file.cpp" won't be accepted.
|
"Update my_file.cpp" won't be accepted.
|
||||||
|
|
||||||
## Contributing to Godot's translation
|
|
||||||
|
|
||||||
You can contribute to Godot's translation from the [Hosted
|
|
||||||
Weblate](https://hosted.weblate.org/projects/godot-engine/godot), an open
|
|
||||||
source and web-based translation platform. Please refer to the [translation
|
|
||||||
readme](editor/translations/README.md) for more information.
|
|
||||||
|
|
||||||
You can also help translate [Godot's
|
|
||||||
documentation](https://hosted.weblate.org/projects/godot-engine/godot-docs/)
|
|
||||||
on Weblate.
|
|
||||||
|
|
||||||
## Communicating with developers
|
|
||||||
|
|
||||||
The Godot Engine community has [many communication
|
|
||||||
channels](https://godotengine.org/community), some used more for user-level
|
|
||||||
discussions and support, others more for development discussions.
|
|
||||||
|
|
||||||
To communicate with developers (e.g. to discuss a feature you want to implement
|
|
||||||
or a bug you want to fix), the following channels can be used:
|
|
||||||
|
|
||||||
- [Godot Contributors Chat](https://chat.godotengine.org): You will
|
|
||||||
find most core developers there, so it's the go-to platform for direct chat
|
|
||||||
about Godot Engine development. Feel free to start discussing something there
|
|
||||||
to get some early feedback before writing up a detailed proposal in a GitHub
|
|
||||||
issue.
|
|
||||||
- [Bug tracker](https://github.com/godotengine/godot/issues): If there is an
|
|
||||||
existing issue about a topic you want to discuss, just add a comment to it -
|
|
||||||
many developers watch the repository and will get a notification. You can
|
|
||||||
also create a new issue - please keep in mind to create issues only to
|
|
||||||
discuss quite specific points about the development, and not general user
|
|
||||||
feedback or support requests.
|
|
||||||
- [Feature proposals](https://github.com/godotengine/godot-proposals/issues):
|
|
||||||
To propose a new feature, we have a dedicated issue tracker for that. Don't
|
|
||||||
hesitate to start by talking about your idea on the Godot Contributors Chat
|
|
||||||
to make sure that it makes sense in Godot's context.
|
|
||||||
|
|
||||||
Thanks for your interest in contributing!
|
|
||||||
|
|
||||||
—The Godot development team
|
|
||||||
|
Loading…
Reference in New Issue
Block a user