The Ritchie CLI project has been archived by Zup Innovation. It might start again eventually; however, we won't deliver support for now.

Table of contents

1. Ritchie's commons formula repository

i. Create a new formula

ii. Add support to other languages on create formula command

2. Documentation

3. Contributing

i. Developer Certificate of Origin - DCO

4. Community

Ritchie's commons formula repository

This repository contains the community formulas ritchie-cli executes.

Create a new formula

You can create your own formula by following these steps:

Step 1. Fork the repository;

Step 2. Create a branch: git checkout -b <branch_name>;

Step 3. Create a new formula, using the forked repository as a Ritchie workspace: rit create formula If you need help check out how to create formulas on Ritchie on our documentation.

Step 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

Step 5. Run pre-commit.sh to lint your code;

Step 6. Run go test -v ./.github/workflows/validation/... to test your code and formula structure. (GoLang Required);

Step 7. Commit your implementation;

Step 8. Push your branch;

Step 9. Open a pull request on the repository for analysis.

Add support to other languages on create formula command

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

Documentation

For more information, access Ritchie's documentation.

Contributing

Feel free to use, recommend improvements, or contribute to new implementations.

Check out our contributing guide to learn about our development process, how to suggest bug fixes and improvements.

Developer Certificate of Origin - DCO

This is a security layer for the project and for the developers. It is mandatory. Follow one of these two methods to add DCO to your commits:

1. Command line

Follow the steps:

Step 1: Configure your local git environment adding the same name and e-mail configured at your GitHub account. It helps to sign commits manually during reviews and suggestions.

git config --global user.name “Name”
git config --global user.email “[email protected]”

Step 2: Add the Signed-off-by line with the '-s -S' flag in the git commit command:

$ git commit -s -S -m "This is my commit message"

2. GitHub website

You can also manually sign your commits during GitHub reviews and suggestions, follow the steps below:

Step 1: When the commit changes box opens, manually type or paste your signature in the comment box, see the examples:

e.g: Signed-off-by: Name < e-mail address >

$ git commit -m “My signed commit” Signed-off-by: username <email address>

For this method, your name and e-mail must be the same registered to your GitHub account.

Choose a branch

One of the first things to decide is which branch to base your work on. If you get confused, just ask and we will help you. If a reviewer realizes you have based your work on the wrong branch, we'll let you know so that you can rebase it.

Community

Feel free to reach out to us at:

Zup Open Source Forum