Skip to content

Commit

Permalink
docs: update contribution doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Tochemey committed Jun 6, 2024
1 parent b4ea937 commit 6f37ff1
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 11 deletions.
18 changes: 12 additions & 6 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
Contributions are welcome!
# Contributions are welcome

The project adheres to [Semantic Versioning](https://semver.org) and [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
This repo uses [Earthly](https://earthly.dev/get-earthly).

To contribute please:
- Fork the repository
- Create a feature branch
- Submit a [pull request](https://help.github.com/articles/using-pull-requests)
There are two ways you can become a contributor:

1. Request to become a collaborator, and then you can just open pull requests against the repository without forking it.
2. Follow these steps
- Fork the repository
- Create a feature branch
- Set your docker credentials on your fork using the following secret names: `$DOCKER_USER` and `$DOCKER_PASS`
- Submit a [pull request](https://help.github.com/articles/using-pull-requests)

## Test & Linter

### Test & Linter
Prior to submitting a [pull request](https://help.github.com/articles/using-pull-requests), please run:

```bash
earthly +test
```
13 changes: 8 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,13 +212,16 @@ Contributions are welcome!
The project adheres to [Semantic Versioning](https://semver.org) and [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
This repo uses [Earthly](https://earthly.dev/get-earthly).

To contribute please:
There are two ways you can become a contributor:

- Fork the repository
- Create a feature branch
- Submit a [pull request](https://help.github.com/articles/using-pull-requests)
1. Request to become a collaborator, and then you can just open pull requests against the repository without forking it.
2. Follow these steps
- Fork the repository
- Create a feature branch
- Set your docker credentials on your fork using the following secret names: `$DOCKER_USER` and `$DOCKER_PASS`
- Submit a [pull request](https://help.github.com/articles/using-pull-requests)

#### Test & Linter
## Test & Linter

Prior to submitting a [pull request](https://help.github.com/articles/using-pull-requests), please run:

Expand Down

0 comments on commit 6f37ff1

Please sign in to comment.