Effect AWS Monorepo

A collection of libraries simplifying AWS integrations within the Effect ecosystem

Effect Website: https://www.effect.website
Effect API Reference: https://effect-ts.github.io/effect
Effect AWS Website: https://effect-aws.website
Effect AWS API Reference: https://floydspace.github.io/effect-aws

Monorepo Structure

The Effect AWS monorepo is organized into clients (having same name as native AWS clients) and helper packages. Below is an overview of the packages included:

Documentation

API Reference

For a complete API reference of the effect-aws packages, see the Effect AWS API documentation.

Contributing Guidelines

Thank you for considering contributing to our project! Here are some guidelines to help you get started:

Reporting Bugs

If you have found a bug, please open an issue on our issue tracker and provide as much detail as possible. This should include:

• A clear and concise description of the problem
• Steps to reproduce the problem
• The expected behavior
• The actual behavior
• Any relevant error messages or logs

Suggesting Enhancements

If you have an idea for an enhancement or a new feature, please open an issue on our issue tracker and provide as much detail as possible. This should include:

• A clear and concise description of the enhancement or feature
• Any potential benefits or use cases
• Any potential drawbacks or trade-offs

Pull Requests

We welcome contributions via pull requests! Here are some guidelines to help you get started:

1. Fork the repository and clone it to your local machine.
2. Create a new branch for your changes: git checkout -b my-new-feature
3. Install dependencies: pnpm install (pnpm@9.x, using corepack or nix preferred)
   • if you introduce new dependencies, please use .projenrc.ts to add them
   • then run pnpm default to update the project
4. Make your changes and add tests if applicable.
5. Run the tests: pnpm test
6. Commit your changes: git commit -am 'Add some feature'
7. Push your changes to your fork: git push origin my-new-feature
8. Open a pull request against our main branch.

Pull Request Guidelines

• Please make sure your changes are consistent with the project's existing style and conventions.
• Please write clear commit messages and include a summary of your changes in the pull request description.
• Please make sure all tests pass and add new tests as necessary.
• If your change requires documentation, please update the relevant documentation.
• Please be patient! We will do our best to review your pull request as soon as possible.

License

By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.