Giter Club home page Giter Club logo

repo-checklist's Introduction

version   downloads

Lightweight utility helps to setup up repo community standards


  • Pull Request Template: Create pull request template for features and bugs
  • Issue Template: Create issue template for feature requests and bug reports
  • Contributing Guide: Create contributing guidelines for a project

split

Usage

Run the command in the root directory of the project

npx repo-checklist

It will launch a interactive UI that guides you through adding Repo Community Standard by simply typing yes to add in your project and no to skip it.

Repo Checklist Demo

Generated files on the following paths

  • Pull Request Template: <your_project_roor>/.github/PULL_REQUEST_TEMPLATE.md
  • Contributing Guide: <your_project_roor>/CONTRIBUTING.md
  • Issue Template
    • Feature: <your_project_roor>/.github/ISSUE_TEMPLATE/FEATURE.yml
    • Fix: <your_project_roor>/.github/ISSUE_TEMPLATE/FIX.yml

split

Future Roadmap

Following are the future items that we will add

  • Issue Template Webform Support
  • Code Owners Support

Any contributions are welcome!

split

Contributing

Guidelines outlines the guidelines for contributing to this project.

split

Star

Don't forget to hit the ⭐, If you like this repository.

split

License

Distributed under the MIT License. See LICENSE for more information.

repo-checklist's People

Contributors

mab540 avatar nabeel-shakeel avatar

Stargazers

 avatar  avatar

Forkers

sheraz064-ai

repo-checklist's Issues

[Feature]: Add Repo Check Flow Using Prompts

Add Repo Checklist flow of prompts and adding PR, contribution, and Issues templates.

. Title of the pull request.
. Description of the pull request.

If the pull request is valid then add a Ready to Review label on the pull request.

Setup project skeleton

  • Setup project skeleton by taking inspiration from create-vite
  • Add necessary dependencies and test the basic version
  • Add steps in README

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.