Skip to content
This repository has been archived by the owner on Jul 12, 2022. It is now read-only.

Commit

Permalink
[FEATURE] Preparing for Hacktoberfest (#236)
Browse files Browse the repository at this point in the history
* merge master

* resolve conflicts

* merge upstream

* removing demo formulas

* update security file

* update contributing file
  • Loading branch information
GuillaumeFalourd authored Sep 21, 2020
1 parent b869c6f commit 8d563b3
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 16 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- markdownlint-disable MD013-->
<!-- Contributing from template
(https://github.com/docker/docker.github.io/blob/master/CONTRIBUTING.md) -->

Expand Down Expand Up @@ -103,3 +104,9 @@ without that last important touch on code.

Ritchie does not currently maintain a style guide. Use your best judgment, and
try to follow the example set by the existing files.

## Hacktoberfest

- If you want to contribute with something thay doesn't have any ISSUE yet, you can create a new detailed ISSUE for our team to evaluate, and they will eventually add a Hackoberfest label to allow you to participate the event resolving this ISSUE.

- Formulas created for the Hacktoberfest will be submitted to our team review before validation for the [Zup Hacktoberfest event](https://insights.zup.com.br/hacktoberfest/).
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- markdownlint-disable MD041 MD033 -->
<!-- markdownlint-disable MD041 MD033 MD013-->
[![CircleCI](https://circleci.com/gh/ZupIT/ritchie-formulas/tree/ritchie-2.0.0.svg?style=shield)](https://circleci.com/gh/ZupIT/ritchie-formulas)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

Expand All @@ -11,18 +11,18 @@ This repository contains the community formulas which can be executed by the [ri
## Create a new formula

1. Fork the repository.
1. Create a branch:`git checkout -b <branch_name>`
1. Create a new formula, using the forked repository as a Ritchie
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](https://docs.ritchiecli.io/getting-started/creating-formulas)
1. Build and use the new formula: `rit build formula`
or use --watch to watch changes on formula code: `rit build formula --watch`
1. Run `pre-commit.sh` to lint your code
1. Run `go test -v ./.circleci/validation/...` to test your code and formula
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 ./.circleci/validation/...` to test your code and formula
structure. _(GoLang Required)_
1. Commit your implementation.
1. Push your branch.
1. Open a pull request on the repository for analysis.
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

Expand All @@ -34,12 +34,12 @@ the following tutorial:

## Full Documentation

- [Gitbook](https://docs.ritchiecli.io)
[Gitbook](https://docs.ritchiecli.io)

## Contributing

[Contribute to the Ritchie community](https://github.com/ZupIT/ritchie-cli/blob/master/CONTRIBUTING.md)

## Zup Products

- [Zup open source](https://opensource.zup.com.br)
[Zup open source](https://opensource.zup.com.br)
12 changes: 8 additions & 4 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,14 @@ currently being supported with security updates.

| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |
| 2.6.x | :white_check_mark: |
| 2.5.x | :white_check_mark: |
| 2.4.x | :white_check_mark: |
| 2.3.x | :white_check_mark: |
| 2.2.x | :white_check_mark: |
| 2.1.x | :white_check_mark: |
| 2.0.x | :white_check_mark: |
| < 2.0 | :x: |

## Reporting a Vulnerability

Expand Down

0 comments on commit 8d563b3

Please sign in to comment.