Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 853 Bytes

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 853 Bytes

Contribute Guide

Pull Request Guidelines

  • Checkout a topic branch from main branch, and merge back against that branch.
  • Work in the src and templates folders.
  • Use fbi commit to commit your code.

Development

  • Setup

    npm i -g fbi
yarn

# link local factory to global env, so you can use it everywhere in terminal. (like `npm link`)
fbi link

  • Start development

    yarn watch

Test

  • In a git repository folder

    fbi commit

Project Structure

  • src
    • index.ts: factory class entry file. It extends fbi Factory.
    • src/commands: contains all executable commands which extends fbi Command.