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
Charlotte
Sharkey
Commits
7e30910a
Unverified
Commit
7e30910a
authored
3 years ago
by
syuilo
Committed by
GitHub
3 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Update CONTRIBUTING.md
parent
7fbee704
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
+18
-9
18 additions, 9 deletions
CONTRIBUTING.md
with
18 additions
and
9 deletions
CONTRIBUTING.md
+
18
−
9
View file @
7e30910a
...
...
@@ -19,22 +19,23 @@ Issueを作成する前に、以下をご確認ください:
## PRの作成
PRありがとうございます! PRを作成する前に、以下をご確認ください:
-
可能であればタイトルに、以下で示すようなPRの種類が分かるキーワードをプリフィクスしてください。
-
fix / refactor / feat / enhance / perf / chore
-
`
fix
`
/
`
refactor
`
/
`
feat
`
/
`
enhance
`
/
`
perf
`
/
`
chore
`
など
-
また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。
-
このPRによって解決されるIssueがある場合は、そのIssueへの参照を本文内に含めてください。
-
[
`CHANGELOG.md`
](
/CHANGELOG.md
)
に変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。
-
この変更により新たに作成、もしくは更新すべきドキュメントがないか確認してください。
-
機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。
-
テスト、Lintが通っていることを予め確認してください。
-
`npm run test`
、
`npm run lint`
でぞれぞれ実施可能です
-
`npm run test`
、
`npm run lint`
でぞれぞれ実施可能です
。
[
詳細
](
#testing
)
-
UIに変更がある場合はスクリーンショットを本文内に添付してください。
ご協力ありがとうございます🤗
## Branches
*
**master**
branch is tracking the latest release and used for production purposes.
*
**develop**
branch is where we work for the next release.
*
**l10n_develop**
branch is reserved for localization management.
## ブランチ
-
**`master`**
branch is tracking the latest release and used for production purposes.
-
**`develop`**
branch is where we work for the next release.
-
PRを作成するときは、基本的にこのブランチに向けてください。
-
**`l10n_develop`**
branch is reserved for localization management.
## Localization (l10n)
Misskey uses
[
Crowdin
](
https://crowdin.com/project/misskey
)
for localization management.
...
...
@@ -50,14 +51,22 @@ If your language is not listed in Crowdin, please open an issue.
*
Documents for instance admins are located in
[
`/docs`
](
/docs
)
.
*
Documents for end users are located in
[
`/src/docs`
](
/src/docs
)
.
## Test
*
Test codes are located in
[
`/test`
](
/test
)
.
## Test
ing
-
Test codes are located in
[
`/test`
](
/test
)
.
### Run specify test
### Run test
```
npm run test
```
#### Run specify test
```
npx cross-env TS_NODE_FILES=true TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT="./test/tsconfig.json" npx mocha test/foo.ts --require ts-node/register
```
### e2e tests
TODO
## Continuous integration
Misskey uses GitHub Actions for executing automated tests.
Configuration files are located in
[
`/.github/workflows`
](
/.github/workflows
)
.
...
...
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