Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.44 KB

Contributing To Cithak

Cithak was a simple utility CLI to manage templates and was published under MIT license. It was written in Javascript (node.js).

Bugs

If you found a bug on our CLI, we really appreciate if you want to give your time to report it on Cithak Github issues, please use the issue template and take a look around and see if someone already opened an issue about it. And if you sure this is na unreported bug you can submit a bug report.

Feature Request

If you have any feature idea that you would like to implement in Cithak, we will really happy if you want to give your time to create a feature request.

Installation

  1. Install npm and node.js with version higher than 10.
  2. Clone this repository.
  3. Run npm install in the root of the repository.
  4. Run npm run dev to watch changes and build them using rollup.
  5. To use cithak, run npm link.
  6. now you can use cth or cithak to use cithak

Pull Request

  • Fork cithak repository
  • Create a new branch with name of your changes
  • Clone your forked repo and do some changes on your branch
  • Test your changes, and after it's good
  • please send us your pull request

License

By contributing to Cithak, you agree that your contributions will be licensed under its MIT license.