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

Add a CONTRIBUTING.md and refactor the README.md #621

Closed
wants to merge 3 commits into from

Conversation

ripytide
Copy link
Member

Should close #526

@ripytide
Copy link
Member Author

I've just seen the README.md has a contributing section, perhaps the best move would be to move that information into the CONTRIBUTING.md and replace it with a link to the CONTRIBUTING.md?

@ripytide ripytide changed the title Add a CONTRIBUTING.md Add a CONTRIBUTING.md and refactor the README.md May 20, 2024
@ripytide
Copy link
Member Author

I've also added the remaining undocumented crate features to the README.md

@theotherphil
Copy link
Contributor

This is a good idea but I want to tinker with the wording a bit so I’ll merge a jointly-authored PR with a variation on this soon.

@theotherphil
Copy link
Contributor

Tweaked version merged in #640.

I'd assumed that adding a co-authored-by comment on the PR description in GitHub would add you as a co-author but it looks like not.

@ripytide
Copy link
Member Author

I think you have to add a Co-authored-by: Name <email> in the commit message after a newline according to the docs to get GitHub to show both user-icons.

But it doesn't really matter, I don't mind.

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.

Testing requires nightly?
2 participants