Skip to content

Update Contribution Guidelines #147

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
merged 4 commits into from
Aug 21, 2025
Merged

Conversation

StudentKyle
Copy link
Contributor

@StudentKyle StudentKyle commented Aug 21, 2025

A lot of the guidelines written are outdated. This PR describes more relevant information, including encouraging small PRs. This also removes the feature-patch branch required distinction, because not all branches fit into either a feature or a patch, and the word "feature" is often redundant given the rest of the branch name (i.e. add-, remove-, fix-). Branches should still have a descriptive, specific name.

@StudentKyle StudentKyle self-assigned this Aug 21, 2025
Copy link

Doxygen warnings output: (if empty, there are no warnings). Please correct any warnings before merging.

  

@StudentKyle StudentKyle requested a review from Rishi-H August 21, 2025 21:56
@roccoagain roccoagain self-requested a review August 21, 2025 23:37
Copy link
Collaborator

@roccoagain roccoagain left a comment

Choose a reason for hiding this comment

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

LGTM

@roccoagain roccoagain merged commit 17e36aa into main Aug 21, 2025
2 checks passed
@roccoagain roccoagain deleted the remove-feature-patch-distinction branch August 23, 2025 23:11
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.

2 participants