Add CONTRIBUTING.md and STYLEGUIDE.md #6340
Open
+716
−62
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
Updated all issue templates to include checklists from CONTRIBUTING Updated PR template to include checcklists from CONTRIBUTING Moved styleguide into its own file
Created merge checklist
pkmnsnfrn
added
the
type: documentation
AlexOn1ine
reviewed
Feb 25, 2025
Co-authored-by: Alex <[email protected]>
AlexOn1ine
reviewed
Feb 25, 2025
AlexOn1ine
reviewed
Feb 25, 2025
hedara90
reviewed
Feb 26, 2025
CONTRIBUTING.md
Outdated
| #### 3. Create a new branch | ||
| This will create a new branch and switch to it. | ||
| ```bash | ||
| git checkout -b newFeature # the name newFeature can be anything you want. This tutorial assumes you used newFeature. |
There was a problem hiding this comment.
git switch -c newFeature also works
There was a problem hiding this comment.
Is there a difference / should I change it? legitimately asking
There was a problem hiding this comment.
I don't think it's a functional difference.
But git switch only handles switching branches, while checkout does much more stuff. I prefer to use switch for branch switching.
docs/STYLEGUIDE.md
Outdated
| prefixed with `s`. | ||
|
|
||
| ```c | ||
| extern int gMyGlobalVariable; |
fdeblasio
reviewed
Feb 26, 2025
docs/STYLEGUIDE.md
Outdated
|
|
||
| ### Comments | ||
|
|
||
| Ideally, contributions have descriptive variable, function and constant names so as to explain functionality without comments. When a comment is used, the content of the comment dhould explain _WHY_ a specific system or component works the way it does. |
fdeblasio
reviewed
Feb 26, 2025
docs/STYLEGUIDE.md
Outdated
| if (bar) | ||
| foo++; | ||
|
|
||
| return foo; // incorrect |
Co-authored-by: hedara90 <[email protected]>
Co-authored-by: hedara90 <[email protected]>
This reverts commit 56eccd1.
Added ghoulslash expertise
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.
Description
CONTRIBUTING.md, which instructs users on how to contribute pull requests, bug reports, and feature requests to expansion.CONTRIBUTING.mdSTYLEGUIDE.mdto codify our existing "rules"docs/team_procedures/merge_checklist.mdto help maintainers remember what should be done before merging a PRPeople who collaborated with me in this PR
@Pawkkie, @garakmon
Discord contact info
pkmnsnfrn
There is a discussion thread.