Skip to content
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

Build Scan capitalization appears consistent in user-facing text #182

Open
etiennestuder opened this issue Oct 30, 2022 · 3 comments
Open

Comments

@etiennestuder
Copy link
Member

No description provided.

@erichaagdev erichaagdev self-assigned this Dec 27, 2022
@erichaagdev erichaagdev removed their assignment May 30, 2023
@runningcode
Copy link
Contributor

Is this still something that needs to be done?

@etiennestuder
Copy link
Member Author

Yes.

@erichaagdev
Copy link
Member

Additionally, we should be consistent with how we refer to the project.

The proper name is Develocity Build Validation Scripts. It should never be written as:

  • build validation scripts
  • Build Validation Scripts
  • validation scripts
  • scripts

When referring to an individual script (e.g. to execute), it should be fine to simply refer to it as a script. For example:

✅ Each script represents a so-called experiment
✅ there are five different scripts that you can execute
✅ The following arguments are present on all scripts

Finally, we should be consistent with usages of script and experiment. It's easy to conflate the two which could be confusing to users. There may not be any action on this one, but I wanted to include it as something to keep in mind when writing any user facing text.

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

No branches or pull requests

3 participants