Documentation: Add Readme, contributing guidelines and complete checklist for each repo
Closed this issue · 1 comments
dcwalk commented
Add readme to each repo from our template, each repo should have:
- [ ] Readme `README.md`
- [ ] **OOPS! Please note that the file paths in the README template need to be updated** . Replace `REPONAME` with the name of hte repository!
- [ ] Repo Badges for: Github Project, Slack, License
- [ ] 1-3 sentence description of repository contents
- [ ] Getting Involved section
- [ ] Development section
- [ ] License -- `LICENSE`
- [ ] Contributing Guidelines (minimal and pointing to org-wide) `.github/CONTRIBUTING.md`
- [ ] Issue Template -- `.github/ISSUE_TEMPLATE.md`
- [ ] GitHub Description from 1-3 sentence readme blurb
How to edit:
- Using GitHub's Web Interface
- Clone and work locally using your preferred text editor
Task Champion:
@titaniumbones and @dcwalk
titaniumbones commented
done!!! 🚀