Skip to content

Update AV1706: Don't use abbreviations#371

Open
dennisdoomen wants to merge 1 commit intodevelopfrom
copilot/pr298-update-av1706
Open

Update AV1706: Don't use abbreviations#371
dennisdoomen wants to merge 1 commit intodevelopfrom
copilot/pr298-update-av1706

Conversation

@dennisdoomen
Copy link
Copy Markdown
Owner

This PR updates guideline AV1706.

It was split out of #298 so the change can be reviewed independently.

Files:

  • _rules/1706.md

Part of the replacement for #298.

Split from #298.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
For example, use `ButtonOnClick` rather than `BtnOnClick`. Avoid single character variable names, such as `i` or `q`. Use `index` or `query` instead.

**Exceptions:** Use well-known acronyms and abbreviations that are widely accepted or well-known in your work domain. For instance, use acronym `UI` instead of `UserInterface` and abbreviation `Id` instead of `Identity`.
**Exceptions:** Use well-known acronyms and abbreviations that are widely accepted or well-known in your work domain. For instance, use acronym `UI` instead of `UserInterface` and abbreviation `Id` instead of `Identity`. For abbreviations of two letters, use all capitals (e.g. `IO`). For abbreviations longer than two letters, only capitalize the first letter (e.g. `Http`, `Xml`, `Json`).
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The added guidance is good in itself, but didn't it already appear in another rule?

@@ -6,4 +6,4 @@ severity: 2
---
For example, use `ButtonOnClick` rather than `BtnOnClick`. Avoid single character variable names, such as `i` or `q`. Use `index` or `query` instead.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, use `ButtonOnClick` rather than `BtnOnClick`. Avoid single character variable names, such as `i` or `q`. Use `index` or `query` instead.
For example, use `ChangePassword` rather than `ChangePwd`. Avoid single-character variable names, such as `i` or `q`. Use `index` or `query` instead.

In light of not focusing on events anymore.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants