You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Your contribution is always appreciated!
4
4
5
-
Contributions don't need to be perfect, but they must move GodSVG in the right direction. If you are planning to implement a feature or overhaul a system, it's important to write a proposal and discuss your ideas. I will try to quickly accept or decline them. Please do understand that PRs with a large maintenance cost may be under high scrutiny because of their long-term responsibility, even in the absence of the original contributor.
5
+
Contributions don't need to be perfect, but they must move GodSVG in the right direction. If you are planning to implement a feature or overhaul a system, it's important to write a proposal and discuss your ideas first. I will try to be quick with accepting or declining them. Please do understand that PRs with a large maintenance cost may be under high scrutiny because of their long-term responsibility, even in the absence of the original contributor.
6
6
7
7
## Setup
8
8
@@ -19,8 +19,8 @@ Look through the list of issues to see if your contribution would resolve any of
19
19
1. Fork the repository.
20
20
2. Create a new branch: `git checkout -b implement-gradients`
21
21
3. Make your modifications, add them with `git add .`
22
-
4. Commit your changes: `git commit -m "Implement linear gradients"`
23
-
5. Push to the branch: `git push origin implement-gradients`
22
+
4. Commit your changes: `git commit -m "Implement the mask element"`
23
+
5. Push to the branch: `git push origin implement-masks`
24
24
6. Create a new pull request with a clear and informative title and describe your changes.
25
25
26
26
This is the preferred workflow, but tidiness is not as important as work being done, so feel free to do something different you may be comfortable with.
@@ -37,16 +37,16 @@ To document some quirks of our code that we've decided on:
37
37
38
38
- StringNames are avoided when possible. We do this because it makes the codebase simpler, although if something is actually shown to be performance-critical, it can be reconsidered.
39
39
- Nodes may only be exported if their runtime structure isn't known.
40
-
-Translating is done via `TranslationServer.translate()` rather than `tr()`. We've decided to stick to this everywhere because `tr()` doesn't work in static contexts.
40
+
-Strings are always translated with `Translator.translate()`, not `tr()`.
41
41
42
42
## Code style
43
43
44
44
For scripts, only GDScript code is allowed. Follow the [GDScript style guide](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_styleguide.html). Most of its rules are enforced here. Additionally:
45
45
46
-
- Static typing is predominantly used.
47
-
- Comments are normally written like sentences with punctuation.
48
-
- Two spaces are used to separate code and inline comments.
46
+
- Static typing is used as much as possible.
47
+
- Comments are typically written like sentences with punctuation.
48
+
- Two spaces are used to separate inline comments and code.
49
49
- For empty lines in the middle of indented blocks, the scope's indentation is kept.
50
50
- Class names use `class_name X extends Y` syntax.
51
51
52
-
Don't make pull requests for code style changes without discussing them first (unless it's for corrections to abide by the ones described here). Pull requests may also get production tweaks to fix their style before being merged.
52
+
Don't make pull requests for code style changes without discussing them first (unless it's for corrections to abide by the ones described here). The same generally applies to making style changes unrelated to a PR's main goal. Pull requests may also get production tweaks to tweak their style before being merged.
0 commit comments