-
Notifications
You must be signed in to change notification settings - Fork 268
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
docs(xo-core): update guidelines #8194
Draft
OlivierFL
wants to merge
3
commits into
master
Choose a base branch
from
xo6/update-guidelines-v2
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains 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
MathieuRA
requested changes
Dec 16, 2024
}>() | ||
|
||
defineSlots<{ | ||
icon(): any |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
icon(): any | |
icon?(): any |
OlivierFL
force-pushed
the
xo6/update-guidelines-v2
branch
from
December 17, 2024 10:23
ff6e1bd
to
921b1ca
Compare
J0ris-K
requested changes
Dec 20, 2024
OlivierFL
force-pushed
the
xo6/update-guidelines-v2
branch
from
December 20, 2024 10:16
921b1ca
to
b6ebd76
Compare
OlivierFL
force-pushed
the
xo6/update-guidelines-v2
branch
from
December 20, 2024 15:50
b4f07d6
to
0d40b19
Compare
ByScripts
reviewed
Dec 20, 2024
Comment on lines
5
to
39
- Avoid using a single letter or non-meaningful names for variables: | ||
|
||
❌ Bad | ||
|
||
```ts | ||
const m = 'foo' | ||
``` | ||
|
||
✅ Good | ||
|
||
```ts | ||
const message = 'foo' | ||
``` | ||
|
||
- If the variable is an array of items, use plural for the variable naming: | ||
|
||
❌ Bad | ||
|
||
```ts | ||
const vm: VM[] = [] | ||
``` | ||
|
||
✅ Good | ||
|
||
```ts | ||
const vms: VM[] = [] | ||
``` | ||
|
||
- When iterating over arrays, use a meaningful name for each item: | ||
|
||
❌ Bad | ||
|
||
```ts | ||
vms.map(item => item.id) | ||
``` | ||
|
||
✅ Good | ||
|
||
```ts | ||
vms.map(vm => vm.id) | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What would you think of moving "❌ Bad" and "✅ Good" inside the code block for single line examples?
Suggested change
- Avoid using a single letter or non-meaningful names for variables: | |
❌ Bad | |
```ts | |
const m = 'foo' | |
``` | |
✅ Good | |
```ts | |
const message = 'foo' | |
``` | |
- If the variable is an array of items, use plural for the variable naming: | |
❌ Bad | |
```ts | |
const vm: VM[] = [] | |
``` | |
✅ Good | |
```ts | |
const vms: VM[] = [] | |
``` | |
- When iterating over arrays, use a meaningful name for each item: | |
❌ Bad | |
```ts | |
vms.map(item => item.id) | |
``` | |
✅ Good | |
```ts | |
vms.map(vm => vm.id) | |
``` | |
- Avoid using a single letter or non-meaningful names for variables: | |
```ts | |
// ❌ Bad | |
const m = 'foo' | |
// ✅ Good | |
const message = 'foo' | |
``` | |
- If the variable is an array of items, use plural for the variable naming: | |
```ts | |
// ❌ Bad | |
const vm: VM[] = [] | |
// ✅ Good | |
const vms: VM[] = [] | |
``` | |
- When iterating over arrays, use a meaningful name for each item: | |
```ts | |
// ❌ Bad | |
vms.map(item => item.id) | |
// ✅ Good | |
vms.map(vm => vm.id) | |
``` |
OlivierFL
force-pushed
the
xo6/update-guidelines-v2
branch
from
December 20, 2024 16:18
0d40b19
to
fe54970
Compare
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.
Description
web-core
,XO 6
andXO Lite
Checklist
Fixes #007
,See xoa-support#42
,See https://...
)Introduced by
CHANGELOG.unreleased.md
Review process
Notes: