Skip to content

Commit

Permalink
docs: explaining how to contribuite
Browse files Browse the repository at this point in the history
  • Loading branch information
KaueSabinoSRV17 committed Jun 22, 2023
1 parent df5de80 commit addf8b1
Showing 1 changed file with 33 additions and 6 deletions.
39 changes: 33 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ A CLI tool made to help developers using Git Flow and Conventional Commits.

## How to Install

Currently, it can be Installed via
Currently, it can be Installed via:

### Brew

````bash
```bash
brew install KaueSabinoSRV17/homebrew-flower/flower
``````
```

### Linux Binary

Expand All @@ -25,9 +25,36 @@ rm Flower_1.0.6_linux_amd64.tar.gz

Currently, it has only the `commit` command:

````bash
```bash
flow commit
``````
```

It will ask you what files you are going to add to git, what is going to be the Conventional Commit prefix
and the Commit Message. After that, you can run `git log` to validate the commit
and the Commit Message. After that, you can run `git log` to validate the commit.

## Contribuitions

### Project Structure

The Structure can and probaly should be changed, it would be very welcome some advices on how to organize
the files and folders properly, since i come from `Typescript` Development.

#### .github directory

Where we store `yaml` files for the ci/cd runs in Github Actions. Currently, i use `goreleaser` to automate
the publishing to `brew`.

#### cmd directory

Where we store `Go` files generated by `Cobra`. They add the functionality of a CLI to the business logic inside
`use_cases`.

#### infra

Where we store `terraform` files that describe and mainteen any infrastructure that we need to publish the CLI.
Currently there is only a `S3 Bucket` in `AWS`, that we are trying to use as a repository for `apt`, making it
easier to install on Linux.

#### use_cases directory

Where we store business logic to implement the `Use Cases` of the CLI (Currently only Conventional Commits).

0 comments on commit addf8b1

Please sign in to comment.