Welcome, and thanks for considering contributing to rules_img.
There are many useful ways to help which don't involve modifying the source code:
- Improving the documentation, user-facing or internal, technical or high-level
- Reviewing changes from other contributors
- Creating, commenting, and voting on discussions for new features
The rest of this document is concerned with changes to the code.
For small fixes and improvements, it is generally acceptable to open a pull request with your change. If you find a bug and don't know how to best address it, create an issue first. Support for features and large changes warrant the creation of a discussion. This way we avoid contributors putting effort into work that is unlikely to be merged, prioritize new features and discuss how to implement complex changes.
- The README contains user-facing documentation, including setup in your own Bazel project and configuring authentication for different services.
- The docs directory contains detailed documentation on each rule, as well as a guide on choosing a push strategy.
rules_img is maintained by Tweag. The current project steward is Malte Poll (@malt3).
You can also join our Discord server and talk to us directly.
Please refer to HACKING.md to set up a development environment, test the code on a Bazel project and run integration tests.