Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
godot
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
community
godot
Commits
40765302
Commit
40765302
authored
Nov 20, 2018
by
Rémi Verschelde
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add some links to CONTRIBUTING.md
parent
33947a57
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
17 additions
and
1 deletion
+17
-1
CONTRIBUTING.md
CONTRIBUTING.md
+17
-1
No files found.
CONTRIBUTING.md
View file @
40765302
...
@@ -59,7 +59,8 @@ by drag and dropping the file in the GitHub edition field.
...
@@ -59,7 +59,8 @@ by drag and dropping the file in the GitHub edition field.
If you want to add new engine functionalities, please make sure that:
If you want to add new engine functionalities, please make sure that:
*
This functionality is desired.
*
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 (on either
*
You talked to other developers on how to implement it best (on either
communication channel, and maybe in a GitHub issue first before making your
communication channel, and maybe in a GitHub issue first before making your
PR).
PR).
...
@@ -70,10 +71,18 @@ Similar rules can be applied when contributing bug fixes - it's always best to
...
@@ -70,10 +71,18 @@ 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.
[
This blog post
](
https://godotengine.org/article/will-your-contribution-be-merged-heres-how-tell
)
outlines the process used by core developers when assessing PRs. We strongly
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.
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://docs.godotengine.org/en/latest/development/cpp/
)
for an introduction to developing on Godot.
for an introduction to developing on Godot.
The
[
Contributing docs
](
http://docs.godotengine.org/en/latest/community/contributing/index.html
)
also have important information on the PR workflow and the code style we use.
#### Be nice to the git history
#### Be nice to the git history
Try to make simple PRs that handle one specific topic. Just like for reporting
Try to make simple PRs that handle one specific topic. Just like for reporting
...
@@ -93,6 +102,9 @@ Internet).
...
@@ -93,6 +102,9 @@ Internet).
This git style guide has some good practices to have in mind:
This git style guide has some good practices to have in mind:
[
Git Style Guide
](
https://github.com/agis-/git-style-guide
)
[
Git Style Guide
](
https://github.com/agis-/git-style-guide
)
See our
[
PR workflow
](
http://docs.godotengine.org/en/latest/community/contributing/pr_workflow.html
)
documentation for tips on using Git, amending commits and rebasing branches.
#### Format your commit logs with readability in mind
#### Format your commit logs with readability in mind
The way you format your commit logs is quite important to ensure that the
The way you format your commit logs is quite important to ensure that the
...
@@ -138,6 +150,10 @@ Weblate](https://hosted.weblate.org/projects/godot-engine/godot), an open
...
@@ -138,6 +150,10 @@ Weblate](https://hosted.weblate.org/projects/godot-engine/godot), an open
source and web-based translation platform. Please refer to the
[
translation
source and web-based translation platform. Please refer to the
[
translation
readme](editor/translations/README.md) for more information.
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
## Communicating with developers
The Godot Engine community has
[
many communication
The Godot Engine community has
[
many communication
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment