Code Monkey home page Code Monkey logo

open-source-repo-checklist's Introduction

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.