Open with intent - we welcome contributions - we want pull requests and to hear about issues.
The README should be addressed to somebody who's never seen this before. But also don't assume that they're a novice.
Does this repo publish to pub.dev or similar? In which case the code user just needs a pointer there - e.g. at_client on pub.dev
This is the person who we want working with us here. CONTRIBUTING.md is going to have the detailed guidance on how to setup their tools, tests and how to make a pull request.
What is the purpose of this project?
What is needed to get the project and its dependencies installed?
How does this work? How is this used to fulfil its intended purpose?
Does the writing flow, with proper grammar and correct spelling?
Are the links to external resources correct? Are the links to other parts of the project correct (beware stuff carried over from previous repos where the project might have lived during earlier development)?
Has the Description field been filled out?
Have we correctly acknowledged the work of others (and their Trademarks etc.) where appropriate (per the conditions of their LICENSE?
Which LICENSE are we using?
Is the LICENSE(.md) file present?
Does it have the correct dates, legal entities etc.?
Who created this?
Do they have complete GitHub profiles?
How can they be contacted?
Who is going to respond to pull requests?