search

image-rs / imageproc

Image processing operations
MIT License
758 stars 150 forks source link

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

Closed ripytide closed 6 months ago

ripytide commented 6 months ago

Should close #526

ripytide commented 6 months ago

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 commented 6 months ago

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

theotherphil commented 6 months ago

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 commented 6 months ago

Tweaked version merged in https://github.com/image-rs/imageproc/pull/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 commented 6 months ago

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.