Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 973 Bytes

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 973 Bytes

Contribution Guidelines

Pull Requests

Rules

  1. Appease the linter
  2. Bump the version
  3. Adjust the Readme according to your changes (if applicable)
  4. No extra dependencies unless absolutely necessary

Guidelines

  1. Try using built-in output functions (err, inf, prompt, menu_line_* and die) instead of echo and printf
  2. Don't echo-pipe into another command if avoidable
  3. Indent with tabs
  4. Try using shell builtins over external commands

Testing

Our parsing was broken in the past and it will break in the future

To spot breakage early, test with the following anime:

  • The safe bet: One Piece
  • Episode 5.5: arifureta shokugyou de sekai saikyou
  • Unicode: Saenai Heroine no Sodatekata ♭
  • Unreleased: boku-no-hero-academia-the-movie-3
  • Old anime: Paprika

Test automation ideas welcome

How else can I help?

  • Join the discord
  • Vote on polls there
  • Star the repo
  • Follow the maintainers