-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
20 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters