Skip to content

Commit

Permalink
Merge pull request #8 from gruntwork-io/feat/updating-readme
Browse files Browse the repository at this point in the history
feat: Updating README.md
  • Loading branch information
yhakbar authored Jul 12, 2024
2 parents 3d5e375 + 1d9ff5a commit 3b82132
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing

As a component in the Terragrunt ecosystem, contribution largely follows the guidelines set forth in [Terragrunt documentation](https://terragrunt.gruntwork.io/docs/community/contributing/).

If you would like to contribute to the Terragrunt Engine, please follow the guidelines below:

1. Create an issue or an RFC to discuss the proposed changes.
2. Fork the repository.
3. Update documentation as appropriate based on the changes you would like to introduce.
4. Make your changes.
5. Run linters, tests and formatters.
6. Create a pull request.

Note that the maintainers of Terragrunt will do their best to review your pull request in a timely manner, but it may take some time to get a response. We appreciate your patience.

If possible, highlight the importance of your pull request to the broader Terragrunt community in the pull request description, and encourage the community to participate in the discussion.

16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# terragrunt-engine-go

This repository contains the implementation of the Terragrunt Engine written in Go.
This repository contains the implementation of the [Terragrunt](https://github.com/gruntwork-io/terragrunt) Engine written in Go.
It uses gRPC for communication and Protocol Buffers for data serialization, ensuring high performance and scalability.

Make commands:
Expand All @@ -15,9 +15,19 @@ Make commands:
* `Run(RunRequest) returns (stream RunResponse)`: Runs a command.
* `Shutdown(ShutdownRequest) returns (stream ShutdownResponse)`: Shuts down the engine.

## Example engine implementation
## Engines

Example engine implementation can be found in the `test/engine_test.go` file.
Impelmentations of the Terragrunt Engine include:

- [terragrunt-engine-opentofu](https://github.com/gruntwork-io/terragrunt-engine-opentofu)

## Example Engine Implementation

Example engine implementation can be found in the [test/engine_test.go](./test/engine_test.go) file.

## Contributions

Contributions are welcome! Check out the [Contributing Guidelines](./CONTRIBUTING.md) for more information.

## License

Expand Down

0 comments on commit 3b82132

Please sign in to comment.