aperture

What is Aperture?

Aperture is the first open-source flow control and reliability management platform for modern web applications.

Aperture enables flow control through observing, analyzing, and actuating, facilitated by agents and a controller.

For more detailed description, refer to the docs.

Playground

To try aperture in local K8s environment, refer to Playground docs.

Contributing

We would really appreciate you help!

See our Code of Conduct.

Reporting bugs or requesting features

Reporting bugs helps us improve Aperture to be more reliable and user friendly. Please make sure to include all the required information to reproduce and understand the bug you are reporting.

Follow helper questions in bug report template to make it easier.

If you see a way to improve Aperture, use the feature request template to create an issue. Make sure to explain the problem you are trying to solve and what is the expected behavior.

Creating Pull Requests

When you are ready to contribute, pick an issue you'd like to solve. Try starting with:

• Good First Issue

For your convenience, all the needed development tools can be installed with asdf.

Before committing, install pre-commit hooks, which will automatically check if your code meets our standards.

pre-commit install --hook-type={pre-commit,commit-msg,prepare-commit-msg}
pre-commit install-hooks

After your first PR is created you would be asked to sign our Contributor License Agreement.

Resources

For better understanding of Aperture, refer to the following resources.

• Documentation