Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
Sharkey
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Dima Krasner
Sharkey
Commits
a23a10d3
Commit
a23a10d3
authored
5 years ago
by
Aya Morisawa
Committed by
syuilo
5 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Improve CONTRIBUTING.md (#5157)
parent
01e77161
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+26
-19
26 additions, 19 deletions
CONTRIBUTING.md
with
26 additions
and
19 deletions
CONTRIBUTING.md
+
26
−
19
View file @
a23a10d3
...
...
@@ -7,18 +7,18 @@ Feature suggestions and bug reports are filed in https://github.com/syuilo/missk
*
Please search existing issues to avoid duplication. If your issue is already filed, please add your reaction or comment to the existing one.
*
If you have multiple independent issues, please submit them separately.
## Localization (l10n)
Misskey uses
[
Crowdin
](
https://crowdin.com/project/misskey
)
for localization management.
You can improve our translations with your Crowdin account.
Changes you make in Crowdin will be merged into develop branch.
Changes you make in Crowdin will be merged into
the
develop branch
by @syuilo
.
If you can
'
t find the language you want to contribute with, please open an issue.
If you can
no
t find the language you want to contribute with, please open an issue.

## Internationalization (i18n)
Misskey uses
[
vue-i18n
](
https://github.com/kazupon/vue-i18n
)
.
Misskey uses the Vue.js plugin
[
Vue I18n
](
https://github.com/kazupon/vue-i18n
)
.
Documentation of Vue I18n is available at http://kazupon.github.io/vue-i18n/introduction.html .
## Documentation
*
Documents for contributors are located in
[
`/docs`
](
/docs
)
.
...
...
@@ -29,14 +29,13 @@ Misskey uses [vue-i18n](https://github.com/kazupon/vue-i18n).
*
Test codes are located in
[
`/test`
](
/test
)
.
## Continuous integration
Misskey uses CircleCI for automated test.
Misskey uses CircleCI for
executing
automated test
s
.
Configuration files are located in
[
`/.circleci`
](
/.circleci
)
.
## FAQ
### Conflict occured at yarn.lock
Just execute
`npx yarn`
(or
`yarn`
when you installed yarn in global) to fix it.
### How to resolve conflictions occurred at yarn.lock?
Just execute
`npx yarn`
(or
`yarn`
when you have yarn installed globally) to fix it.
## Glossary
### AP
...
...
@@ -57,11 +56,15 @@ Convert な(na) to にゃ(nya)
#### Denyaize
Revert Nyaize
##
Code s
tyle
###
セミコロンを省略しない
ASI Hazardを避けるためでもある
##
TypeScript Coding S
tyle
###
Do not omit semicolons
This is to avoid Automatic Semicolon Insertion (ASI) hazard.
### 中括弧を省略しない
Ref:
*
https://www.ecma-international.org/ecma-262/#sec-automatic-semicolon-insertion
*
https://github.com/tc39/ecma262/pull/1062
### Do not omit curly brackets
Bad:
```
ts
if
(
foo
)
...
...
@@ -79,16 +82,20 @@ if (foo) {
}
```
ただし
**`if`が一行**
の時だけは省略しても良い
As a special case, you can omit the curly brackets if
*
the body of the
`if`
-statement have only one statement and,
*
the
`if`
-statement does not have
`else`
-clause.
Good:
```
ts
if
(
foo
)
bar
;
```
###
特別な理由がない限り
`===`
を使う
###
Do not use `==` when it can simply be replaced with
`===`
.
🥰
###
null系を除いて、bool以外の値をifに渡さない
###
Use only boolean (or null related) values in the condition of an `if`-statement.
Bad:
```
ts
if
(
foo
.
length
)
...
...
@@ -99,12 +106,12 @@ Good:
if
(
foo
.
length
>
0
)
```
### `export default`
を使わない
インテリセンスと相性が悪かったりするため
###
Do not use
`export default`
This is because the current language support does not work well with
`export default`
.
参考:
*
https://gfx.hatenablog.com/entry/2017/11/24/135343
Ref:
*
https://basarat.gitbooks.io/typescript/docs/tips/defaultIsBad.html
*
https://gfx.hatenablog.com/entry/2017/11/24/135343
Bad:
```
ts
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment