Skip to content

Commit

Permalink
Merge pull request #34 from brunopadz/docs/update-contribution
Browse files Browse the repository at this point in the history
docs: update readme and contributing guide
  • Loading branch information
brunopadz authored Oct 10, 2021
2 parents 751102f + 2cb818b commit 09b3d4d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
15 changes: 11 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,17 @@

There are just a few guidelines you need to follow in order to contribute to amictl.

## Code reviews
The `main` branch does not reflect the latest release.

## New features

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
Check for any open issues or feature requests, if the feature you're looking to implement is not listed, please consider
opening an issue for discussion.

## Project
Pull Requests with features that were not previously discussed may be closed without further notice. So, consider opening
an issue. :)

## Code reviews

New features, bug fixes and refactoring must be added to the [Roadmap project](https://github.com/brunopadz/amictl/projects/2).
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose.
Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,14 @@

- [How to use](docs/how_to_use.md)
- [Download it!](https://github.com/brunopadz/amictl/releases/latest)
- Feel free to [contribute](CONTRIBUTING.md)
- Feel free to [contribute](CONTRIBUTING.md). Keep in mind that the `main` branch does not reflect the latest release.
- AWS is the only cloud provider supported to this date

## What is amictl?

amictl is a super simple cli app to control your AMIs and Image IDs.
amictl is a super simple cli app to control your AMIs and Image IDs. It currently supports AWS to list used and unused
AMIs.

## And what does it do?

So far, it shows how many AMIs/Image IDs you're not using and how much you could be saving.

## Disclaimer

- There are a ton of features that still need to be implemented. Just check the [contributing guide](CONTRIBUTING.md) and the open [issues](https://github.com/brunopadz/amictl/issues).
There are a lot of features that still need to be implemented. Just check the
[contributing guide](CONTRIBUTING.md) and the open a new [issue](https://github.com/brunopadz/amictl/issues) to start a
discussion.

0 comments on commit 09b3d4d

Please sign in to comment.