-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
First pass at copy editing the CD/RO blueprint add-on
- Loading branch information
1 parent
10e753e
commit 5ac75aa
Showing
11 changed files
with
199 additions
and
163 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,23 +1,34 @@ | ||
# Contributing | ||
|
||
This document provides guidelines for contributing to the module. | ||
This document provides guidelines for contributing to the CloudBees CD/RO add-on for Amazon EKS blueprints. | ||
|
||
## Dependencies | ||
|
||
Validate your changes inside the blueprint-agent described in [.Dockerfile](blueprints/Dockerfile). It can be run `make dBuildAndRun`. | ||
|
||
## Pre-commits: Linting, Formatting and Secrets Scanning | ||
## Report bugs and feature requests | ||
|
||
CloudBees welcomes you to use the GitHub issue tracker to report bugs or suggest features. | ||
|
||
Many of the files in the repository can be linted or formatted to | ||
maintain a standard of quality. | ||
When filing an issue: | ||
|
||
Additionally, secret leaks are watched via gitleaks and git-secrets. | ||
1. Check existing open and recently closed [issues](https://github.com/cloudbees/terraform-aws-cloudbees-cd-eks-addon/issues) to ensure the issue has not already been reported. | ||
2. Review the upstream repositories: | ||
- [aws-ia/terraform-aws-eks-blueprints](https://github.com/aws-ia/terraform-aws-eks-blueprints/issues) | ||
- [aws-ia/terraform-aws-eks-blueprints-addons](https://github.com/aws-ia/terraform-aws-eks-blueprints-addons/issues) | ||
3. Try to include as much information as you can. Details like the following are incredibly useful: | ||
- A reproducible test case or series of steps | ||
- The version of code being used | ||
- Any modifications you have made relevant to the bug | ||
- Anything unusual about your environment or deployment | ||
|
||
## Pre-commits: Linting, Formatting and Secrets Scanning | ||
|
||
When working with the repository for the first time run pre-commit | ||
Many of the files in the repository can be linted or formatted to maintain a standard of quality. Additionally, secret leaks are watched via [gitleaks](https://github.com/zricethezav/gitleaks#pre-commit) and [git-secrets](https://github.com/awslabs/git-secrets). | ||
|
||
Run `pre-commit install` | ||
Run `pre-commit run --all-files` | ||
1. When working with the repository for the first time, you must install `pre-commit`. For more information, refer to [pre-commit installation](https://pre-commit.com/#installation). | ||
2. Run `pre-commit run --all-files`. Run this command again if the automated checks fail when you create a pull request. | ||
|
||
## Release Drafter | ||
|
||
This repository uses [Release Drafter](https://github.com/release-drafter/release-drafter) thus it is recommended to use [Semantic Commit Messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716) to ease labelling your Pull Request accordingly. | ||
This repository uses [Release Drafter](https://github.com/release-drafter/release-drafter) thus it is recommended to use [Semantic Commit Messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716) to ease labelling your pull request accordingly. |
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
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
Oops, something went wrong.