Skip to content
This repository has been archived by the owner on Apr 30, 2024. It is now read-only.

Latest commit

 

History

History
60 lines (54 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

60 lines (54 loc) · 1.7 KB
Raw

Contributing to tsci

First off, thanks for taking the time to contribute! 🎉👍

How Can I Contribute?

It is publicly open for any contribution. Reporting bugs, suggesting enhancements, bugfixes, new features and extras are welcome.

  • To contribute to code:
    • Fork the repo
    • Create a branch for your change(s)
    • Push your change(s) to your fork
    • Open a Pull Request(PR).
  • To report a bug: If something does not work, please report it using GitHub Issues.

Development setup 🛠

Install dependencies first.

npm install

Build your changes.

npm run build

Before complete your changes run below commands to be lint and format code base.

npm run format

Testing your changes 🧪

After your changes run the test script to test your code.

npm run test

Then testing your latest cli in action first run build script and you can install your changes locally and test the changes. First build your changes.

npm run build

Then you can test your changes in two ways. First you can check your changes below command

node ./lib/cli.js

Other option is install your changes locally and test it directly cli command like below.

npm install -g .

Then you can call cli command whenever you want inside your project folder or another test folder.

tsci

After your test if you want you can uninstall test cli from your machine with below command.

npm uninstall -g tsci

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.