Add Best Practice: Naming Root Projects #34468
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@bot-gradle test this |
This comment has been minimized.
This comment has been minimized.
tresat
added
a:documentation
|
The following builds have passed: |
lkasso
changed the title
Herudaio
reviewed
Jul 31, 2025
platforms/documentation/docs/src/docs/userguide/best-practices/best_practices_general.adoc
Outdated
Show resolved
Hide resolved
platforms/documentation/docs/src/docs/userguide/best-practices/best_practices_general.adoc
Outdated
Show resolved
Hide resolved
platforms/documentation/docs/src/docs/userguide/best-practices/best_practices_index.adoc
Outdated
Show resolved
Hide resolved
platforms/documentation/docs/src/docs/userguide/best-practices/best_practices_general.adoc
Outdated
Show resolved
Hide resolved
tresat
force-pushed
the
tt/bestpractices/92/name-your-root-project
branch
from
91434b5 to
9987d24
Compare
liutikas
approved these changes
Aug 26, 2025
...s/documentation/docs/src/docs/userguide/reference/best-practices/best_practices_general.adoc
Show resolved
Hide resolved
lkasso
approved these changes
Sep 8, 2025
...s/documentation/docs/src/docs/userguide/reference/best-practices/best_practices_general.adoc
Outdated
Show resolved
Hide resolved
...s/documentation/docs/src/docs/userguide/reference/best-practices/best_practices_general.adoc
Outdated
Show resolved
Hide resolved
...s/documentation/docs/src/docs/userguide/reference/best-practices/best_practices_general.adoc
Outdated
Show resolved
Hide resolved
...s/documentation/docs/src/docs/userguide/reference/best-practices/best_practices_general.adoc
Outdated
Show resolved
Hide resolved
...s/documentation/docs/src/docs/userguide/reference/best-practices/best_practices_general.adoc
Outdated
Show resolved
Hide resolved
...s/documentation/docs/src/docs/userguide/reference/best-practices/best_practices_general.adoc
Outdated
Show resolved
Hide resolved
...s/documentation/docs/src/docs/userguide/reference/best-practices/best_practices_general.adoc
Show resolved
Hide resolved
...s/documentation/docs/src/docs/userguide/reference/best-practices/best_practices_general.adoc
Outdated
Show resolved
Hide resolved
...s/documentation/docs/src/docs/userguide/reference/best-practices/best_practices_general.adoc
Outdated
Show resolved
Hide resolved
...s/documentation/docs/src/docs/userguide/reference/best-practices/best_practices_general.adoc
Show resolved
Hide resolved
Recommends that root projects be explicitly named in settings files. This ensures consistency and avoids potential issues with default naming based on directory names. Also disables CC on the serveDocs task so that errors are more visible.
tresat
force-pushed
the
tt/bestpractices/92/name-your-root-project
branch
from
9987d24 to
e1c99c0
Compare
Co-authored-by: Laura Kassovic <lkassovic@gradle.com> Signed-off-by: Tom Tresansky <tom.tresansky@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Recommends that root projects be explicitly named in settings files.
This ensures consistency and avoids potential issues with default naming based on directory names.
./gradlew :docs:docsTest --tests "*snippet-best-practices-name-your-root-project*"