/formulas-github

Ritchie CLI formulas interacting with Github APIs 🐙

Primary LanguagePython

Ritchie Formulas Github

Rit banner

Documentation

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

Formulas available on this repository

Use Formulas

To import this repository, you need Ritchie CLI installed

Then, you can use the rit add repo command manually, or execute the command line below directly on your terminal:

echo '{"provider":"Github", "name":"formulas-github", "url":"https://github.com/GuillaumeFalourd/formulas-github", "priority":1}' | rit add repo --stdin

Finally, you can check if the repository has been imported correctly by executing the rit list repo command.

Contribute to the repository with your formulas

Creating formulas

  1. Fork and clone the repository
  2. Create a branch: git checkout -b <branch_name>
  3. Check the step by step of how to create formulas on Ritchie
  4. Add your formulas to the repository and commit your implementation: git commit -m '<commit_message>
  5. Push your branch: git push origin <project_name>/<location>
  6. Open a pull request on the repository for analysis.

Updating Formulas

  1. Fork and clone the repository
  2. Create a branch: git checkout -b <branch_name>
  3. Add the cloned repository to your workspaces (rit add workspace) with a highest priority (for example: 1).
  4. Check the step by step of how to implement formulas on Ritchie and commit your implementation: git commit -m '<commit_message>
  5. Push your branch: git push origin <project_name>/<location>
  6. Open a pull request on the repository for analysis.