Skip to content
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

Merged
merged 10 commits into from
Aug 20, 2023
Merged

Conversation

paul-hansen
Copy link
Contributor

@paul-hansen paul-hansen commented Aug 12, 2023

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.

CONTRIBUTING.md Outdated
Comment on lines 7 to 8
AccessKit intentionally includes the `Cargo.lock` file in our git repository.
This is mainly due to our bindings to other languages.
Copy link
Contributor Author

@paul-hansen paul-hansen Aug 12, 2023

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.

Comment on lines +1 to +2
# Contributing to AccessKit

Copy link
Contributor Author

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.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@paul-hansen paul-hansen changed the title Add CONTRIBUTING.md docs: Add CONTRIBUTING.md Aug 12, 2023
@DataTriny
Copy link
Member

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:

Contributions to AccessKit are welcome. Please see CONTRIBUTING.md.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@DataTriny
Copy link
Member

@paul-hansen I've updated the file, trying to be exhaustive but concise. Let me know what you think about it.

@paul-hansen
Copy link
Contributor Author

paul-hansen commented Aug 20, 2023

Looks great!

@mwcampbell mwcampbell merged commit 3a7e63a into AccessKit:main Aug 20, 2023
5 checks passed
lunixbochs pushed a commit to talonvoice/accesskit that referenced this pull request Aug 31, 2023
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.

Add a CONTRIBUTING.md ?
4 participants