CONTRIBUTING.md

Contributing to the Gradle Cookbook

The Gradle Cookbook is under active development. Any contributions are welcome!

Discuss

• #docs on the Gradle Community Slack
• GitHub Issues

Development Environment

Follow this documentation for the community site.

HOWTOs

Editing and Adding Pages

A few tips:

• All the pages on this site are written in Markdown.
• If needed, we have various tools available, such as code templates and macros, and we can add more MkDocs plugins if necessary.
• The Table of Contents is currently located in mkdocs.yml. When adding new pages, please update the ToC to ensure they are discoverable.

Adding New Categories

At the moment, we add categories based on consensus. If you plan to add a new major category, it's better to discuss it in advance.

Previews

For any pull equest with the approved GitHub Actions run, a preview site will be deployed. The build both will share the link in the comments to the pull request.

References

• Main Contributor Guide - describes how to contribute to Gradle