Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: restructure and streamline documentation #1003

Merged
merged 2 commits into from
Oct 5, 2023
Merged

docs: restructure and streamline documentation #1003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b839ae
rewrite docs
kayman-mk Oct 5, 2023
c4cb406
fix spelling
kayman-mk Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Contribution guide

We appreciate your thought to contribute to open source. :heart: We want to make contributing as easy as possible. You are welcome to:
We appreciate your thought to contribute to open source. :heart: We want to make contributing as easy as possible.
You are welcome to:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Report a bug
- Discuss the current state of the code
- Submit a fix
- Propose new features

We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
We use [Github Flow](https://guides.github.com/introduction/flow/index.html), So all code changes happen through pull requests.
We actively welcome your pull requests:

1. Fork the repo and create your branch from `main`.
2. If you've added code, check one of the examples.
Expand All @@ -25,7 +26,8 @@ We use the [Terraform Style conventions](https://www.terraform.io/docs/configura

## Documentation

We use [pre-commit](https://pre-commit.com/) to update the Terraform inputs and outputs in the documentation via [terraform-docs](https://github.com/terraform-docs/terraform-docs). Ensure you have installed those components.
We use [pre-commit](https://pre-commit.com/) to update the Terraform inputs and outputs in the documentation via
[terraform-docs](https://github.com/terraform-docs/terraform-docs). Ensure you have installed those components.

## Testing

Expand Down
Loading