Skip to content

Clearly Label Editable and Non-Editable Sections in build.gradle.kts #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
SableRaf opened this issue Aug 22, 2024 · 1 comment · Fixed by #43
Closed

Clearly Label Editable and Non-Editable Sections in build.gradle.kts #39

SableRaf opened this issue Aug 22, 2024 · 1 comment · Fixed by #43

Comments

@SableRaf
Copy link
Collaborator

The current build.gradle.kts build configuration file contains a USER BUILD CONFIGURATIONS section. However, it may not be clear to users—especially beginners—which parts of the script can be safely edited and which should remain unchanged. This could lead to accidental modifications of critical parts of the build process, resulting in errors or unintended behavior.

Proposed Changes:

Adding a comment to USER BUILD CONFIGURATIONS that explicitly state which part of the code is user-configurable.

// ==========================
// USER BUILD CONFIGURATIONS
// ==========================
// The following section is where you, as the library creator, can customize the settings
// for your library. You can safely edit these values to suit your project needs.

Similarly, sections of the script that are generally not intended for modification by the user should be clearly marked as such.

// ==========================
// INTERNAL BUILD CONFIGURATIONS
// Do not edit the following sections unless you know what you're doing.
// ==========================

Adding a general comment at the beginning of the file to guide users on which parts of the script are typically user-configurable and which are not could also be helpful.

// This Gradle script is designed to help you build and release your Processing library.
// The section marked "USER BUILD CONFIGURATIONS" is intended for customization.
// The rest of the script is responsible for the build process and should typically not be modified.
@mingness
Copy link
Collaborator

Thanks, will integrate in a future PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants