Skip to content

Conversation

liutikas
Copy link
Collaborator

Context

Link to each best practice category directly. Make it quicker to get to each category

Contributor Checklist

  • Review Contribution Guidelines.
  • Make sure that all commits are signed off to indicate that you agree to the terms of Developer Certificate of Origin.
  • Make sure all contributed code can be distributed under the terms of the Apache License 2.0, e.g. the code was written by yourself or the original code is licensed under a license compatible to Apache License 2.0.
  • Check "Allow edit from maintainers" option in pull request so that additional changes can be pushed by Gradle team.
  • Provide integration tests (under <subproject>/src/integTest) to verify changes from a user perspective.
  • Provide unit tests (under <subproject>/src/test) to verify logic.
  • Update User Guide, DSL Reference, and Javadoc for public-facing changes.
  • Ensure that tests pass sanity check: ./gradlew sanityCheck.
  • Ensure that tests pass locally: ./gradlew <changed-subproject>:quickTest.

Reviewing cheatsheet

Before merging the PR, comments starting with

  • ❌ ❓must be fixed
  • 🤔 💅 should be fixed
  • 💭 may be fixed
  • 🎉 celebrate happy things

@liutikas liutikas requested review from a team, lkasso and tresat April 25, 2025 15:44
@liutikas liutikas added the re:footguns-and-best-practices Issues related to avoiding pitfalls in Gradle label Apr 25, 2025
@lkasso lkasso added this pull request to the merge queue Apr 26, 2025
@bot-gradle bot-gradle added this to the 9.0 RC1 milestone Apr 26, 2025
@lkasso
Copy link
Member

lkasso commented Apr 26, 2025

@liutikas, if you want this change to get released to the docs right away (and not wait for Gradle 9.0), you should also make it on the release branch.

@lkasso lkasso added the a:documentation Documentation content label Apr 26, 2025
Merged via the queue into gradle:master with commit dacade1 Apr 26, 2025
18 checks passed
@lkasso lkasso changed the title Link to each best practice category directly Update Best Practices: Link to each best practice category directly Jun 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a:documentation Documentation content re:footguns-and-best-practices Issues related to avoiding pitfalls in Gradle

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants