Skip to content

Commit 92db204

Browse files
ota-meshiota-meshi
authored
Repository Maintenance (#186)
1 parent 973813f commit 92db204

40 files changed

+1159
-1133
lines changed

‎.eslintrc.js‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎.github/workflows/ci.yml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,17 @@ on:
55
branches: [master]
66

77
jobs:
8-
build-docs:
8+
build-and-lint:
99
runs-on: ubuntu-latest
1010
steps:
1111
- uses: actions/checkout@v4
1212
- uses: actions/setup-node@v4
1313
- name: Install Packages
1414
run: |
1515
npm i -f
16-
- name: Build all
16+
- name: Lint
17+
run: |
18+
npm run lint
19+
- name: Build
1720
run: |
1821
npm run build

‎.npmrc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
package-lock=false
1+
package-lock=false
2+
force=true

‎.prettierrc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"tabWidth": 2,
3+
"useTabs": false
4+
}

‎.vitepress/config.mjs‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const repoUrl = pkg.repository.url
1616
/** @type {import("vitepress").DefaultTheme.Sidebar} */
1717
const links = {
1818
"/documents/forJava/": [
19-
{ text: "Home", link: "/documents/forJava/" },
19+
{ text: "Introduction", link: "/documents/forJava/" },
2020
{
2121
text: "Javaコーディング規約",
2222
link: "/documents/forJava/Javaコーディング規約.html",
@@ -31,7 +31,7 @@ const links = {
3131
},
3232
],
3333
"/documents/forSQL/": [
34-
{ text: "Home", link: "/documents/forSQL/" },
34+
{ text: "Introduction", link: "/documents/forSQL/" },
3535
{
3636
text: "SQLコーディング規約（PostgreSQL）",
3737
link: "/documents/forSQL/SQLコーディング規約（PostgreSQL）.html",
@@ -42,14 +42,14 @@ const links = {
4242
},
4343
],
4444
"/documents/forAWSResource/": [
45-
{ text: "Home", link: "/documents/forAWSResource/" },
45+
{ text: "Introduction", link: "/documents/forAWSResource/" },
4646
{
4747
text: "AWSインフラ命名規約",
4848
link: "/documents/forAWSResource/AWSインフラリソース命名規約.html",
4949
},
5050
],
5151
"/documents/forOpenAPISpecification/": [
52-
{ text: "Home", link: "/documents/forOpenAPISpecification/" },
52+
{ text: "Introduction", link: "/documents/forOpenAPISpecification/" },
5353
{
5454
text: "OpenAPI Specification 2.0規約",
5555
link: "/documents/forOpenAPISpecification/OpenAPI_Specification_2.0.html",
@@ -60,7 +60,7 @@ const links = {
6060
},
6161
],
6262
"/documents/forGitBranch/": [
63-
{ text: "Home", link: "/documents/forGitBranch/" },
63+
{ text: "Introduction", link: "/documents/forGitBranch/" },
6464
{
6565
text: "Gitブランチフロー規約",
6666
link: "/documents/forGitBranch/git_branch_standards.html",
@@ -83,7 +83,7 @@ const links = {
8383
},
8484
],
8585
"/documents/forSlack/": [
86-
{ text: "Home", link: "/documents/forSlack/" },
86+
{ text: "Introduction", link: "/documents/forSlack/" },
8787
{
8888
text: "Slack利用ガイドライン",
8989
link: "/documents/forSlack/slack_usage_guidelines.html",
@@ -152,7 +152,7 @@ export default defineConfig({
152152
text: "Java",
153153
items: [
154154
{
155-
text: "Home",
155+
text: "Introduction",
156156
link: "/documents/forJava/",
157157
},
158158
{
@@ -173,7 +173,7 @@ export default defineConfig({
173173
text: "SQL",
174174
items: [
175175
{
176-
text: "Home",
176+
text: "Introduction",
177177
link: "/documents/forSQL/",
178178
},
179179
{
@@ -193,7 +193,7 @@ export default defineConfig({
193193
text: "AWS インフラリソース",
194194
items: [
195195
{
196-
text: "Home",
196+
text: "Introduction",
197197
link: "/documents/forAWSResource/",
198198
},
199199
{
@@ -206,7 +206,7 @@ export default defineConfig({
206206
text: "OpenAPI Specification規約",
207207
items: [
208208
{
209-
text: "Home",
209+
text: "Introduction",
210210
link: "/documents/forOpenAPISpecification/",
211211
},
212212
{
@@ -223,7 +223,7 @@ export default defineConfig({
223223
text: "Gitブランチフロー規約",
224224
items: [
225225
{
226-
text: "Home",
226+
text: "Introduction",
227227
link: "/documents/forGitBranch/",
228228
},
229229
{
@@ -236,7 +236,7 @@ export default defineConfig({
236236
text: "Markdown設計ドキュメント規約",
237237
items: [
238238
{
239-
text: "Home",
239+
text: "Introduction",
240240
link: "/documents/forMarkdown/",
241241
},
242242
{
@@ -249,7 +249,7 @@ export default defineConfig({
249249
text: "Slack利用ガイドライン",
250250
items: [
251251
{
252-
text: "Home",
252+
text: "Introduction",
253253
link: "/documents/forSlack/",
254254
},
255255
{

‎.vitepress/theme/components/PageInfo.vue‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export default {
6060
},
6161
},
6262
mounted() {
63-
if(import.meta.env.SSR) return;
63+
if (import.meta.env.SSR) return;
6464
loadScript();
6565
},
6666
};

‎.vscode/settings.json‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
{
22
"eslint.validate": ["javascript", "javascriptreact", "vue"],
3-
"eslint.workingDirectories": ["./", "./.vitepress"],
43
"editor.codeActionsOnSave": {
54
"source.fixAll.eslint": "explicit"
65
},
76
"editor.defaultFormatter": "esbenp.prettier-vscode",
8-
"editor.formatOnSave": true
7+
"editor.formatOnSave": true,
8+
"[markdown]": {
9+
"editor.defaultFormatter": "esbenp.prettier-vscode",
10+
"editor.formatOnSave": true
11+
},
12+
"markdown.extension.tableFormatter.enabled": false
913
}

‎documents/forAWSResource/AWSインフラリソース命名規約.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,10 @@ head:
1818

1919
::: warning 有志で作成したドキュメントである
2020

21-
* フューチャーアーキテクトには多様なプロジェクトが存在し、それぞれの状況に合わせた開発手法が採用されている。本規約はフューチャーアーキテクトの全ての部署／プロジェクトで利用されているわけではなく、有志が観点を持ち寄って新たに整理したものである。相容れない部分があればその領域を書き換えて利用することを想定している
21+
- フューチャーアーキテクトには多様なプロジェクトが存在し、それぞれの状況に合わせた開発手法が採用されている。本規約はフューチャーアーキテクトの全ての部署／プロジェクトで利用されているわけではなく、有志が観点を持ち寄って新たに整理したものである。相容れない部分があればその領域を書き換えて利用することを想定している
2222

2323
:::
2424

25-
2625
## 前提条件
2726

2827
- 開発チームが 3 ～ 30 名程度で構築する規模での利用を想定している
@@ -835,11 +834,11 @@ IAM グループ用のポリシーを作成する例では、company を含め
835834

836835
| Category | Tag Key | Required | Note |
837836
| ------------ | ------- | -------- | ------------------------------------------------------------------------ |
838-
| Common | Env | ✅ | 環境識別子 |
839-
| | System | ✅ | システム名 |
840-
| | Name | ✅ | リソースの識別子として機能名などを設定 |
841-
| 費用按分 | Owner | ✅ | リソースの管理主管部署。費用の負担先を想定 |
842-
| | Project | ✅ | 開発担当チーム。どのチームがどれくらい利用したかをトレースするために設定 |
837+
| Common | Env | ✅ | 環境識別子 |
838+
| | System | ✅ | システム名 |
839+
| | Name | ✅ | リソースの識別子として機能名などを設定 |
840+
| 費用按分 | Owner | ✅ | リソースの管理主管部署。費用の負担先を想定 |
841+
| | Project | ✅ | 開発担当チーム。どのチームがどれくらい利用したかをトレースするために設定 |
843842
| ツールで利用 | StartAt | | 起動時刻。自動化ツールなどで必要があれば設定 |
844843
| | EndAt | | 停止時刻 |
845844

‎documents/forAWSResource/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ sidebarDepth: 4
33
author: フューチャー株式会社
44
layout: home
55
hero:
6-
name: AWSインフラ命名規約
6+
name: AWSインフラ命名規約
77
tagline: Future Enterprise Naming Convention Standards for AWS infrastructure resource
88
actions:
99
- theme: brand

‎documents/forGitBranch/commit_message_rule.md‎

Lines changed: 87 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,87 @@
1-
---
2-
sidebarDepth: 4
3-
title: コミットメッセージ規約
4-
author: フューチャー株式会社
5-
---
6-
7-
# コミットメッセージ規約
8-
9-
Gitのコミットメッセージにの書式についてルール化することで、コミットの目的がわかりやすくなる、履歴からのトラッキングの容易になる利点がある。
10-
11-
本規約のコミットメッセージの書式としては、`Conventional Commits`をベースとした規約としている。
12-
13-
以下の形式でコミットメッセージを記載することとする。
14-
15-
```md
16-
<type>: <subject> <gitmoji>
17-
```
18-
19-
コミットメッセージは
20-
type、subject、gitmojiの最大3つの要素から構成され、それぞれは後述する書式に従うものとする。
21-
この中でも、type、subjectについては必須とし、ほかの要素についてはプロジェクトの運用にしたがい任意とする。
22-
23-
## type
24-
25-
typeについては必須の要素となり、以下のいずれかを選択するものとする。
26-
27-
| type | 説明 |
28-
|--------|--------------------------------------------------------------------------------------|
29-
| `feat` | 新機能の追加 |
30-
| `fix` | バグの修正 |
31-
| `docs` | ドキュメンテーションの更新 |
32-
| `refactor` | リファクタリング|
33-
34-
## subject
35-
36-
subjectについては必須の要素となり、変更内容を簡潔に記載するものとする。
37-
issue idについては、PRから参照する運用を想定し、コミットメッセージの必須要素とはしないこととする。
38-
39-
## gitmoji
40-
41-
gitmojiについては任意の要素となり、変更内容を視認しやすい絵文字の使用を可能とする。
42-
43-
変更内容と選択される絵文字の対応については厳密とせず、開発者が任意に選択するものとする。
44-
45-
type(feat, fix, docs, refactorなど)に基づく、選択例を以下に示す。
46-
47-
```txt
48-
==== Emojis ====
49-
:ambulance: 🚑致命的なバグ修正(fix)
50-
:bug: 🐛バグ修正(fix)
51-
:+1: 👍機能改善・機能修正(fix)
52-
:cop: 👮セキュリティ関連の修正(fix)
53-
:art: 🎨レイアウト関連の修正(fix)
54-
:green_heart: 💚テストやCIの修正・改善(fix)
55-
:wrench: 🔧設定ファイルの修正(fix)
56-
:building_construction: 🏗️アーキテクチャの変更(fix)
57-
:tada: 🎉大きな機能追加(feat)
58-
:sparkles: ✨部分的な機能追加(feat)
59-
:up: 🆙依存パッケージ等のアップデート(feat)
60-
:memo: 📝ドキュメント修正(docs)
61-
:bulb: 💡ソースコードへのコメント追加や修正(docs)
62-
:lipstick: 💄Lintエラーの修正やコードスタイルの修正(refactor)
63-
:recycle: ♻️リファクタリング(refactor)
64-
:fire: 🔥コードやファイルの削除(refactor)
65-
:rocket: 🚀パフォーマンス改善(refactor)
66-
```
67-
68-
## コミットメッセージ例
69-
70-
上記のルールに従った、コミットメッセージのサンプルは以下のようなものとなる。
71-
以下のようなコミットをルールとすることで、変更内容を視覚的に把握しやすくなる利点がある。
72-
73-
```txt
74-
feat: カレンダー機能の追加 🎉
75-
```
76-
77-
```txt
78-
fix: メモリリークの修正 🚑
79-
```
80-
81-
```txt
82-
docs: デプロイフローをドキュメント化 📝
83-
```
84-
85-
```txt
86-
refactor: Lintエラーの修正 💄
87-
```
1+
---
2+
sidebarDepth: 4
3+
title: コミットメッセージ規約
4+
author: フューチャー株式会社
5+
---
6+
7+
# コミットメッセージ規約
8+
9+
Gitのコミットメッセージにの書式についてルール化することで、コミットの目的がわかりやすくなる、履歴からのトラッキングの容易になる利点がある。
10+
11+
本規約のコミットメッセージの書式としては、`Conventional Commits`をベースとした規約としている。
12+
13+
以下の形式でコミットメッセージを記載することとする。
14+
15+
```md
16+
<type>: <subject> <gitmoji>
17+
```
18+
19+
コミットメッセージは
20+
type、subject、gitmojiの最大3つの要素から構成され、それぞれは後述する書式に従うものとする。
21+
この中でも、type、subjectについては必須とし、ほかの要素についてはプロジェクトの運用にしたがい任意とする。
22+
23+
## type
24+
25+
typeについては必須の要素となり、以下のいずれかを選択するものとする。
26+
27+
| type | 説明 |
28+
| ---------- | -------------------------- |
29+
| `feat` | 新機能の追加 |
30+
| `fix` | バグの修正 |
31+
| `docs` | ドキュメンテーションの更新 |
32+
| `refactor` | リファクタリング |
33+
34+
## subject
35+
36+
subjectについては必須の要素となり、変更内容を簡潔に記載するものとする。
37+
issue idについては、PRから参照する運用を想定し、コミットメッセージの必須要素とはしないこととする。
38+
39+
## gitmoji
40+
41+
gitmojiについては任意の要素となり、変更内容を視認しやすい絵文字の使用を可能とする。
42+
43+
変更内容と選択される絵文字の対応については厳密とせず、開発者が任意に選択するものとする。
44+
45+
type(feat, fix, docs, refactorなど)に基づく、選択例を以下に示す。
46+
47+
```txt
48+
==== Emojis ====
49+
:ambulance: 🚑致命的なバグ修正(fix)
50+
:bug: 🐛バグ修正(fix)
51+
:+1: 👍機能改善・機能修正(fix)
52+
:cop: 👮セキュリティ関連の修正(fix)
53+
:art: 🎨レイアウト関連の修正(fix)
54+
:green_heart: 💚テストやCIの修正・改善(fix)
55+
:wrench: 🔧設定ファイルの修正(fix)
56+
:building_construction: 🏗️アーキテクチャの変更(fix)
57+
:tada: 🎉大きな機能追加(feat)
58+
:sparkles: ✨部分的な機能追加(feat)
59+
:up: 🆙依存パッケージ等のアップデート(feat)
60+
:memo: 📝ドキュメント修正(docs)
61+
:bulb: 💡ソースコードへのコメント追加や修正(docs)
62+
:lipstick: 💄Lintエラーの修正やコードスタイルの修正(refactor)
63+
:recycle: ♻️リファクタリング(refactor)
64+
:fire: 🔥コードやファイルの削除(refactor)
65+
:rocket: 🚀パフォーマンス改善(refactor)
66+
```
67+
68+
## コミットメッセージ例
69+
70+
上記のルールに従った、コミットメッセージのサンプルは以下のようなものとなる。
71+
以下のようなコミットをルールとすることで、変更内容を視覚的に把握しやすくなる利点がある。
72+
73+
```txt
74+
feat: カレンダー機能の追加 🎉
75+
```
76+
77+
```txt
78+
fix: メモリリークの修正 🚑
79+
```
80+
81+
```txt
82+
docs: デプロイフローをドキュメント化 📝
83+
```
84+
85+
```txt
86+
refactor: Lintエラーの修正 💄
87+
```

0 commit comments

Comments
 (0)