Skip to content

Improve CONTRIBUTING #163

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

alettsy
Copy link

@alettsy alettsy commented Jul 10, 2025

Hello 👋

The CONTRIBUTING doc was a bit messy and unclear, so I have updated it.

I have kept most of the text that was already there the same, just a bit of restructuring.

I also added code snippet examples for git.

I wasn't sure if you had any specific commit message formats/guidelines, so I included a link to best practices that I find useful and see frequently used. I also assumed that contributions should be made from/merged to the dev branch, not main.

Please let me know if there are any issues! 😊

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.

1 participant