Skip to content

refactor: add additional abbreviations to general agreement#26

Open
lanvalird wants to merge 4 commits intomainfrom
issue-17/add-abbreviations-to-agreement
Open

refactor: add additional abbreviations to general agreement#26
lanvalird wants to merge 4 commits intomainfrom
issue-17/add-abbreviations-to-agreement

Conversation

@lanvalird
Copy link
Copy Markdown
Member

Resolve #17

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
laf-team-docs Ready Ready Preview, Comment Apr 17, 2026 5:27am

@lanvalird lanvalird added the documentation Improvements or additions to documentation label Mar 23, 2026
@lanvalird lanvalird self-assigned this Mar 23, 2026
@lanvalird lanvalird requested a review from a team March 23, 2026 10:05
Copy link
Copy Markdown
Member

@FOCKUSTY FOCKUSTY left a comment

Choose a reason for hiding this comment

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

Категорически против:

  • fmt
  • sub
  • impl

Почему стоит оставить следующие сокращения? (ни разу не видел)

  • cb
  • cnt
  • comp
  • ex/exc
  • idx
  • impl
  • opt
  • orig
  • perm
  • proc
  • ptr
  • pub
  • rel
  • ret
  • sep
  • seq
  • sub

Очень редко вижу:

  • curr
  • dep
  • enc
  • ev
  • ex/exc
  • ext
  • proto
  • usr
  • val
  • vol

Comment thread content/agreements/general.mdx Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Вот насчёт новых сокращений, я уже как-то написал в комментах об исью, также продублирую здесь

Comment thread content/agreements/general.md
- cfg/config — configuration.
- char — character.
- cmd — command.
- cnt — count.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Не нравится и ни разу не видел в практике

- cmd — command.
- cnt — count.
- col — column.
- comp — component.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Не нравится и ни разу не видел в практике

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

пример Comp можно найти в том же RadixUI. Col тоже часто используют, cmd база (хотя я тоже пердпочитаю Column)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Извини за недопонимание, речь была только про Comp

- temp — temporary.
- up — update.
- url — uniform resource locator.
- usr — user.
Copy link
Copy Markdown
Member

@FOCKUSTY FOCKUSTY Mar 23, 2026

Choose a reason for hiding this comment

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

Просто бесполезно, пожалуйста, уберите его отсюда (usr)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Спорно. URL является таким же сокращение, как и HTTP. Хотя здесь я решил уже не выносить мозг

Copy link
Copy Markdown
Member

@FOCKUSTY FOCKUSTY Mar 23, 2026

Choose a reason for hiding this comment

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

Извиняюсь за недопонимание, я неправильно отметил строки, имел в виду только usr

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Вот с usr закину правки 🤗

- temp — temporary.
- up — update.
- url — uniform resource locator.
- usr — user.
- val — value.
Copy link
Copy Markdown
Member

@FOCKUSTY FOCKUSTY Mar 23, 2026

Choose a reason for hiding this comment

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

Я не хочу, чтобы оно тут было, но не буду сильно против, если оставят, вообще кажется, что это сокращение просто не имеет большого смысла (val)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

На самом деле ты прав, потому что внутри команды очень часто используется либо value, либо v (в методах сортировки/перетасовки и тд)

- var — variable.
- ver — version.
- vol — volume.
Copy link
Copy Markdown
Member

@FOCKUSTY FOCKUSTY Mar 23, 2026

Choose a reason for hiding this comment

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

Я не хочу, чтобы оно тут было, но не буду сильно против, если оставят, вообще кажется, что это сокращение просто не имеет большого смысла (vol)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Здесь ещё такой момент, что от языка зависит, потому что в том же JS слово var зарезер... зарезвививано... зарези.... зарезити.... закак.... зарезирвивано, крч

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Извиняюсь за недопонимание, я имел в виду только vol

Comment thread content/agreements/general.mdx Outdated
Comment thread content/agreements/general.mdx Outdated
- Removed duplicate and ambiguous abbreviations from the list
- Standardized format to have only one variant per abbreviation
- Reduced list from 55 to 50 items for better clarity
- Improved consistency in naming conventions
Specify clear conditions for using abbreviations and single-letter variables:
- Added explicit 3 line code limit
- Formulated precise allowed / disallowed conditions
- Added practical code examples
- Fixed ambiguous wording in naming rule 1.6

Updated explanations section exp-1_6 with proper boundaries for short notations in loops and array methods.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Добавить другие сокращения

2 participants