Skip to content

Docs: First draft of contribution guidelines#554

Merged
JoshSanch merged 6 commits intobfbbdecomp:mainfrom
JoshSanch:contribution-guidelines
May 23, 2025
Merged

Docs: First draft of contribution guidelines#554
JoshSanch merged 6 commits intobfbbdecomp:mainfrom
JoshSanch:contribution-guidelines

Conversation

@JoshSanch
Copy link
Collaborator

@JoshSanch JoshSanch commented May 19, 2025

With all of the new contributors coming in lately, I'd like to take this moment to introduce some contribution guidelines to help folks make PRs that will be easy to review and merge into the project.

My goal with this document is to have an accessible list of expectations that contributors can reference ahead of time and allowing for in-depth conversations on guidelines to occur within pull requests when they infrequently occur.

- Josh

@bfbbdecomp bfbbdecomp deleted a comment from github-actions bot May 19, 2025
@bfbbdecomp bfbbdecomp deleted a comment from github-actions bot May 19, 2025
@LivewireCB
Copy link
Contributor

Consider adding a clear definition of variable naming conventions.
for example; using "myVar" instead of "MyVar" or "myvar"

@JoshSanch
Copy link
Collaborator Author

Candidate convention I'd like to add based on this commit:

- Hexadecimal literals used as arguments for asset functions should be represented using char literals when it would improve the readability of the code (i.e 0x504c4154 -> 'PLAT').

@JoshSanch
Copy link
Collaborator Author

I'm adding this line - it's a bit arbitrary but it closely aligns with Heavy Iron's naming standards so I'd like to follow that:

- When DWARF symbols are unavailable, ensure variables are named using camelCase and structs/classes are named using TitleCase, or snake_case if they exist only in an anonymous namespace.

@github-actions

This comment was marked as off-topic.

Copy link
Member

@SquareMan SquareMan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly lgtm.

Feel free to ignore my last comment if you disagree.

@JoshSanch JoshSanch changed the title Meta: First draft of contribution guidelines Docs: First draft of contribution guidelines May 22, 2025
@github-actions

This comment was marked as off-topic.

@JoshSanch
Copy link
Collaborator Author

JoshSanch commented May 22, 2025

Proposing to add:

- Avoid adding functions or data definitions that will need to be cleaned up and removed later for the sake of increasing matchingness in the short-term.

This is inspired by the existing _all_the_floats function, and proposed changes on #567. This is an artifact of the old build/match comparison tooling and is no longer necessary. It also adds clean-up work later for no long-term benefit.

@github-actions

This comment was marked as off-topic.

@JoshSanch
Copy link
Collaborator Author

Going to merge for now - I invite anyone with any further thoughts to raise an issue or to start discussion in the community Discord.

@JoshSanch JoshSanch merged commit c6184e7 into bfbbdecomp:main May 23, 2025
5 checks passed
@JoshSanch JoshSanch deleted the contribution-guidelines branch May 23, 2025 01:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants