Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 1.6 KB

README.md

File metadata and controls

69 lines (50 loc) · 1.6 KB
Raw

Gitarist

A CLI tool to utilize Octokit

Commit everyday does not prove anything

npm version npm bundle size npm download

Installation

npx gitarist setup

Features

  • Multiple useful Github utilities based on Octokit
    • commit automatically
    • clean up stale workflows automatically
    • clean up dummy files automatically
    • pull request
    • merge
    • comment on pull request
    • register issues
    • comment on issues
  • Run cron job using Github Action

Contributing

  1. Fork it
  2. Install dependencies (pnpm install)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git cz or git commit -am 'feat: added some feature')
  5. Test your changes (pnpm test)
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

Quick start

# Rename `.env.example` to `.env` and fill the environment variables
cp .env.example .env

# Install dependencies
pnpm

# In development
pnpm dev

# In production
pnpm build

Code Style

We use Prettier and tslint to maintain code style and best practices. Please make sure your PR adheres to the guides by running:

pnpm format

and

pnpm lint