Ritchie's commons formula repository
This repository contains the community formulas which can be executed by the ritchie-cli.
Create a new formula
- Fork the repository.
- Create a branch:
git checkout -b <branch_name>
- 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 - Build and use the new formula:
rit build formula
or use --watch to keep observing changes on formula code live:rit build formula --watch
- Run
pre-commit.sh
to lint your code - Run
go test -v ./.circleci/validation/...
to test your code and formula structure. (GoLang Required) - Commit your implementation.
- Push your branch.
- 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
Contributing
Contribute to the Ritchie community