-
Notifications
You must be signed in to change notification settings - Fork 54
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
docs: Add CONTRIBUTING.md #272
Conversation
CONTRIBUTING.md
Outdated
AccessKit intentionally includes the `Cargo.lock` file in our git repository. | ||
This is mainly due to our bindings to other languages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A better defense of why this is needed might be a good addition here. I don't know the specific reason myself so this was the best I had.
# Contributing to AccessKit | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A welcoming message, perhaps including something about what types of contributions you are looking for / open to would be fitting to have here.
Felt like it would be disingenuous if I tried to write one as I'm not a regular maintainer.
Thank you for starting this! I think we want to link to this page from the main README. I would add a Contributing chapter above the License one. Something like this should be enough:
|
@paul-hansen I've updated the file, trying to be exhaustive but concise. Let me know what you think about it. |
Looks great! |
Closes #268
"Edits by maintainers" is enabled and more than welcome!
This is my first time making a CONTRIBUTING.md so feel free to just use it as a starting point and/or go a completely different direction.