Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.94 KB

README.md

File metadata and controls

45 lines (32 loc) · 1.94 KB
Raw

CircleCI pre-commit

Ritchie's commons formula repository

This repository contains the community formulas which can be executed by the ritchie-cli.

Create a new formula

  1. Fork the repository.
  2. Create a branch:git checkout -b <branch_name>
  3. Create a new formula, using the forked repository as a Ritchie workspace: rit create formula if you need help please visit how to create formulas on Ritchie
  4. Build and use the new formula: rit build formula or use --watch to keep observing changes on formula code live: rit build formula --watch
  5. Run pre-commit.sh to lint your code
  6. Run go test -v ./.github/workflows/validation/... to test your code and formula structure. (GoLang Required)
  7. Commit your implementation.
  8. Push your branch.
  9. Open a pull request on the repository for analysis.

Add support to other languages on create formula command

The rit create formula command use the folder /templates/create_formula to list the languages options. If you like to edit some language template or to add more language to create formula command please access the following tutorial: Languages Template Tutorial

Full Documentation

Gitbook

Contributing

Contribute to the Ritchie community

Zup Products

Zup open source