Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 966 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 966 Bytes
Raw

Contributing Guidelines

  • Fork the project.
  • Clone the project.
  • Create new branch with based on what you're working like issue-cli.
  • npm install to install required dependencies
  • Make changes and write unit tests if possible.
  • Write proper commits and send PR.

Development

To develop this CLI locally, make sure you npm link it.

# Open the CLI root directory and run.
npm link

# This will link the CLI binary `aaja` so that you can execute it.

Directory Structure

- lib
    -> index.js // Main file which contains main logic

- utils
    -> output.js // consist logic to display output

- tests
    -> test.js // unit tests for above file

Available Scripts

  • npm run test to run unit tests.

Contact

If you wamt any sorts of help . you can raise issue or you can directly ping me on twitter via @aadarshatweets.