Contribution guidelines, update .gdextension configurations
#215
Conversation
This file contains 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
Bromeon
added
documentation
|
bors try |
tryBuild succeeded: |
gg-yb
reviewed
Apr 6, 2023
ReadMe.md
Outdated
| @@ -80,7 +79,7 @@ To register the GDExtension library with Godot, you need to create two files rel | |||
| We highly recommend to have a look at a working example in the `examples/dodge-the-creeps` directory. | |||
| This integrates a small game with Godot and has all the necessary steps set up. | |||
|
|
|||
| API documentation can be generated locally using `cargo doc -p godot --no-deps --open`. | |||
| API documentation can be generated locally using `./check.sh dok` (or `./check doc` to refresh an opened page). | |||
There was a problem hiding this comment.
Suggested change
| API documentation can be generated locally using `./check.sh dok` (or `./check doc` to refresh an opened page). | |
| API documentation can be generated locally using `./check.sh dok` (or `./check.sh doc` to refresh an opened page). |
Might not be the place for discussing it, but just mentioning "dok" as a key is prone to being considered a typo IMO. Maybe we should make it clear (here?) that "dok" (sic!) is meant
There was a problem hiding this comment.
Thanks! Yeah, originally there was just doc and I found myself always wanting to open the browser. Maybe swapping the sentence in the parentheses with the one outside could clarify this.
Bromeon
force-pushed
the
qol/contrib
branch
2 times, most recently
from
7c7710e to
53e8184
Compare
|
bors r+ |
|
Build succeeded: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Elaborates the contribution process, documents
#[itest]and unifies the.gdextensionlibrary entries.Fixes #208.