-
Notifications
You must be signed in to change notification settings - Fork 44
chore: 📝 init CONTRIBUTING.md
#229
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
KANAjetzt
merged 8 commits into
GodotModding:development
from
KANAjetzt:chore_create_CONTRIBUTING_md
Apr 21, 2023
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
da17b37
chore: :memo: init `CONTRIBUTING.md`
KANAjetzt 8bd053f
fix: :pencil2: removed error from copy pasting
KANAjetzt 30af5f1
fix: :pencil2: discord link
KANAjetzt e7f5b2c
chore: :memo: Add request for logs in `Reporting bugs` section
KANAjetzt 9a6d35c
chore: :memo: Note for editing the `Upcoming Features` page
KANAjetzt ff9cb9d
chore: :memo: add line break to `Upcoming Features` note
KANAjetzt 959e50b
chore: :see_no_evil: add `CONTRIBUTING.md` to `.gitattributes`
KANAjetzt ea4ef49
Merge branch 'development' into chore_create_CONTRIBUTING_md
KANAjetzt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| # Contributing Guidelines | ||
|
|
||
| Thank you for considering contributing to our project! We welcome contributions from everyone. Before getting started, please take a moment to read our guidelines. | ||
|
|
||
| ## How to contribute | ||
|
|
||
| 1. Fork the repository. | ||
| 2. Create a new branch for your contribution. | ||
| 3. Make your changes and commit them. | ||
| 4. Push your changes to your fork. | ||
| 5. Submit a pull request. | ||
|
|
||
| ## Reporting bugs | ||
|
|
||
| If you find a bug, please let us know by opening an issue. Be as detailed as possible when describing the issue, including any steps to reproduce the bug. If applicable, please provide your `modloader.log` file from the `user://` (Godot app_userdata) folder. This file contains valuable information that can help us identify the cause of the issue. | ||
|
|
||
| ## Suggesting features | ||
|
|
||
| If you have an idea for a new feature or improvement, please open an issue to discuss it. We welcome all suggestions and will consider them carefully. | ||
|
|
||
| ## Coding style | ||
|
|
||
| Please follow the [Godot 3.5 coding conventions for GDScript](https://docs.godotengine.org/en/3.5/tutorials/scripting/gdscript/gdscript_styleguide.html) | ||
|
|
||
| In addition, please follow these guidelines: | ||
|
|
||
| ### Naming Convention | ||
| - Prefix local (private) to file vars / functions with `_` | ||
| - Prefix classes that should only be used by the ModLoader with `_` | ||
| - If a method is in a non-prefixed class and ModLoader Internal, but used outside of the private scope, prefix with `_`, use it outside the scope, but add a comment why it was used there | ||
|
|
||
| Reasoning: | ||
| 1. Underscore methods/vars should only be used within the same file | ||
| 2. Most classes should not be used by mods, only by the ModLoader. if they are prefixed with an underscore, no mod should access them and we are free to change the internal structure without breaking mods and needing deprecations | ||
| 3. In some cases we need to use private methods outside of their file (`_rotate_log_file` for example) and the class is a public one (`ModLoaderLog` here). Since the method should not be accessible to mods, we are using a "private" method outside of its scope here - and that needs an explanation | ||
|
|
||
| ### String Standards | ||
| - Double quotes over single quotes: `"string"`, not `'string'` | ||
| - Quote escaping over single quotes : `"\"hello\" world"`, not `'"hello" world'` | ||
| - Format strings over string concatenation and `str()`: `"hello %s!" % place`, not `"hello " + place + "!"`, not `str("hello", place)`. Except for very simple cases/single concatenation: `"hello " + place`, not `"hello %s" % place` | ||
| - split long strings into shorter ones with string concatenation `"" + "" + ...`, not `str("", "", ...)` | ||
| ```gdscript | ||
| ModLoaderLog.info( | ||
| "pretend that this" + | ||
| "is a really long" + | ||
| "message" | ||
| ) | ||
| ``` | ||
|
|
||
| ## Documentation | ||
|
|
||
| The documentation for this project is located in the repository's wiki. Please make sure to update the relevant documentation pages when making changes to the code. If you're not sure what needs to be updated, please ask in your pull request or issue. | ||
| *Note that you will mostly edit the [Upcoming Features](https://github.com/GodotModding/godot-mod-loader/wiki/Upcoming-Features) page, where all changes to the dev branch are documented until they become part of the next major update.* | ||
|
|
||
KANAjetzt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Communicating over Discord | ||
| We use Discord for communication and collaboration. You can join our Discord server at [discord.godotmodding.com](https://discord.godotmodding.com). Please use appropriate channels for your discussions and keep conversations respectful and on-topic. | ||
|
|
||
| ## Licensing | ||
|
|
||
| All contributions must be licensed under the same license as the project. By contributing, you agree to license your contributions under the same terms. | ||
|
|
||
| ## Thank you! | ||
|
|
||
| We appreciate your contributions and look forward to working with you. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.