Added contributing.md
This commit is contained in:
parent
92a3b9fb9f
commit
a84dfbc46b
1 changed files with 32 additions and 0 deletions
32
CONTRIBUTING.md
Normal file
32
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,32 @@
|
||||||
|
## PLEASE READ:
|
||||||
|
|
||||||
|
### Reporting Bugs:
|
||||||
|
|
||||||
|
If you are reporting a new issue, you will make our life much simpler (and the fix come much sooner):
|
||||||
|
|
||||||
|
#### Specify the Platform
|
||||||
|
|
||||||
|
Godot runs on a large variety of platforms and operating systems and devices. If you believe your issue is device/platform dependent, please specify:
|
||||||
|
* Operating System
|
||||||
|
* Device
|
||||||
|
* GPU Model
|
||||||
|
|
||||||
|
#### Specify Reproduction Steps
|
||||||
|
|
||||||
|
Many bugs can't be reproduced unless specific steps are taken. Please **specify the exact steps** that must be taken to reproduce the condition.
|
||||||
|
|
||||||
|
#### Provide a Simple, Example Project
|
||||||
|
|
||||||
|
Sometimes an unexpected behavior happens in your project. In such case understand that we can't always take a look at your project. Providing **a simple project** that isolates and reproduces the issue is always the **the best way for us to fix it**.
|
||||||
|
|
||||||
|
### Contributing Pull Requests
|
||||||
|
|
||||||
|
If you are adding new engine funcitonality, please make sure that:
|
||||||
|
|
||||||
|
* This functionality is desired.
|
||||||
|
* You talked to other developers on how to implement it best.
|
||||||
|
* Even if it won't be merged, your PR is useful for future work on another developer.
|
||||||
|
|
||||||
|
Thanks!
|
||||||
|
|
||||||
|
The Godot Development Team
|
Loading…
Reference in a new issue