Create maintainer-specific docs

[ilya-khadykin]

As mentioned in #1086 I think we should create some sort of maintainer-specific docs and document thing related to the best practices we use. It will help us stay on the same page etc

What do you think?

TODO:

• Add docs on how to choose Exceptions correctly per Create maintainer-specific docs #1095 (comment)

[cmccandless]

Some of the information I would imagine the proposed docs would contain (Conventions, Code Style) is already in the README. I don't see why we couldn't put label documentation there as well?

[ilya-khadykin]

I thought that README is targeting contributors more than maintainers. For that reason I've created this issue

[N-Parsons]

@m-a-ge, I'm not sure what documentation we'd need that is specific to maintainers?

However, I think it might be worth putting together a CONTRIBUTING.md (or equivalent) that would give more detail than the README currently does about how to contribute, what conventions we follow, etc. This would be useful both for new people to find and read, and for us to be able to point to when something isn't quite right with a PR. We could probably achieve a lot of the kinds of things you are thinking about with such a document?

[ilya-khadykin]

@N-Parsons yes, that's a good idea

[N-Parsons]

Coming from #1080, part of this documentation could be a list of exception types and when to use them (something like the Choosing Exceptions to Raise Pandas has).

[cmccandless]

For now, the README for this track is adequate as a contributing guide. If someone submits a PR for a more comprehensive CONTRIBUTING.md, it would be welcome, but this is not an urgent need at this time.