https://github.com/eddiejaoude/open-source-repo-checklist

What should YOUR Open Source repo have...
https://github.com/eddiejaoude/open-source-repo-checklist

Last synced: 2 months ago
JSON representation

What should YOUR Open Source repo have...

• Host: GitHub
• URL: https://github.com/eddiejaoude/open-source-repo-checklist
• Owner: eddiejaoude
• License: mit
• Created: 2022-08-06T20:03:35.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-21T21:42:43.000Z (over 2 years ago)
• Last Synced: 2024-10-03T23:41:38.251Z (3 months ago)
• Size: 8.79 KB
• Stars: 33
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Open Source Repo Checklist

What should YOUR Open Source repo have...

## Highly recommended

- Repo settings

  - Description

  - URL (if appropriate)

  - Topics

  - Hide features not using (for example: wiki, packages)

- README

  - Screenshot / animated gif

  - Prerequisite list

    - hardware

    - software

  - Glossary of terms & acronyms

  - QuickStart guide

  - Where to get support / ask questions

- Code of Conduct

- License

## Recommended

- README

  - clear outcomes & needs for the project

  - Audience targeted (skills, knowledge, experience)

- Issue template

- Pull Request template

- GitHub Actions to automate repetitive tasks

- Issue labels

- Releases (create these manually or automatically using a GitHub Action)

# Nice to have

- Project board (to do, in progress, in review, done)