tafia
doc: add contributors guide
Add a guide to help PR submissions.
Suggested by @jqnatividad in https://github.com/tafia/calamine/pull/578#issuecomment-3468261779
Hopefully, it doesn't intimidate folks from contributing...
Hopefully not. I think it is better to have some (or many) guidelines than none.
BTW, I would still like to extend out the clippy checks via a clippy.toml file or similar.
@sftse and @jqnatividad it seems like you both feel this is too prescriptive.
I will try distill it down and make it simpler.
Maybe some of the explicit guidance you can move to a separate MD file for AI guidance?
see https://github.com/mitsuhiko/minijinja/blob/main/CLAUDE.md
Maybe some of the explicit guidance you can move to a separate MD file for AI guidance?
I saw a good article called How I Taught GitHub Copilot Code Review to Think Like a Maintainer.
It was for a (mainly) Rust project so we could copy some of those prompts.
It might make sense to define what the (non-)goals of the guide are, because it's not that clear to me. I would think it's a basic requirement that the necessary tools are understood (git, cargo...) and if they are not to query some AI on how to use them.
I can see adding things to a guide that are less widely established, such as conventional commits. Things caught and covered by CI I don't think need further explanation, mistakes that escape reviewers will surface.