Skip to content

atsign-company/archetype

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Sample README

Open with intent - we welcome contributions - we want pull requests and to hear about issues.

Who is this for?

The README should be addressed to somebody who's never seen this before. But also don't assume that they're a novice.

Code user

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

Contributor

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.

Why, What, How?

Why?

What is the purpose of this project?

What?

What is needed to get the project and its dependencies installed?

How?

How does this work? How is this used to fulfil its intended purpose?

Checklist

Writing

Does the writing flow, with proper grammar and correct spelling?

Links

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)?

Description

Has the Description field been filled out?

Acknowledgement/Attribution

Have we correctly acknowledged the work of others (and their Trademarks etc.) where appropriate (per the conditions of their LICENSE?

LICENSE

Which LICENSE are we using?
Is the LICENSE(.md) file present?
Does it have the correct dates, legal entities etc.?

Maintainers

Who created this?

Do they have complete GitHub profiles?

How can they be contacted?

Who is going to respond to pull requests?

About

Boilerplate repo to hold assets for public repos

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published