Skip to content

Commit

Permalink
Repository Maintenance
Browse files Browse the repository at this point in the history
  • Loading branch information
ota-meshi committed Dec 19, 2024
1 parent 973813f commit 48d4deb
Show file tree
Hide file tree
Showing 40 changed files with 1,159 additions and 1,133 deletions.
7 changes: 0 additions & 7 deletions .eslintrc.js

This file was deleted.

7 changes: 5 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,17 @@ on:
branches: [master]

jobs:
build-docs:
build-and-lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
- name: Install Packages
run: |
npm i -f
- name: Build all
- name: Lint
run: |
npm run lint
- name: Build
run: |
npm run build
3 changes: 2 additions & 1 deletion .npmrc
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
package-lock=false
package-lock=false
force=true
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"tabWidth": 2,
"useTabs": false
}
26 changes: 13 additions & 13 deletions .vitepress/config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const repoUrl = pkg.repository.url
/** @type {import("vitepress").DefaultTheme.Sidebar} */
const links = {
"/documents/forJava/": [
{ text: "Home", link: "/documents/forJava/" },
{ text: "Introduction", link: "/documents/forJava/" },
{
text: "Javaコーディング規約",
link: "/documents/forJava/Javaコーディング規約.html",
Expand All @@ -31,7 +31,7 @@ const links = {
},
],
"/documents/forSQL/": [
{ text: "Home", link: "/documents/forSQL/" },
{ text: "Introduction", link: "/documents/forSQL/" },
{
text: "SQLコーディング規約(PostgreSQL)",
link: "/documents/forSQL/SQLコーディング規約(PostgreSQL).html",
Expand All @@ -42,14 +42,14 @@ const links = {
},
],
"/documents/forAWSResource/": [
{ text: "Home", link: "/documents/forAWSResource/" },
{ text: "Introduction", link: "/documents/forAWSResource/" },
{
text: "AWSインフラ命名規約",
link: "/documents/forAWSResource/AWSインフラリソース命名規約.html",
},
],
"/documents/forOpenAPISpecification/": [
{ text: "Home", link: "/documents/forOpenAPISpecification/" },
{ text: "Introduction", link: "/documents/forOpenAPISpecification/" },
{
text: "OpenAPI Specification 2.0規約",
link: "/documents/forOpenAPISpecification/OpenAPI_Specification_2.0.html",
Expand All @@ -60,7 +60,7 @@ const links = {
},
],
"/documents/forGitBranch/": [
{ text: "Home", link: "/documents/forGitBranch/" },
{ text: "Introduction", link: "/documents/forGitBranch/" },
{
text: "Gitブランチフロー規約",
link: "/documents/forGitBranch/git_branch_standards.html",
Expand All @@ -83,7 +83,7 @@ const links = {
},
],
"/documents/forSlack/": [
{ text: "Home", link: "/documents/forSlack/" },
{ text: "Introduction", link: "/documents/forSlack/" },
{
text: "Slack利用ガイドライン",
link: "/documents/forSlack/slack_usage_guidelines.html",
Expand Down Expand Up @@ -152,7 +152,7 @@ export default defineConfig({
text: "Java",
items: [
{
text: "Home",
text: "Introduction",
link: "/documents/forJava/",
},
{
Expand All @@ -173,7 +173,7 @@ export default defineConfig({
text: "SQL",
items: [
{
text: "Home",
text: "Introduction",
link: "/documents/forSQL/",
},
{
Expand All @@ -193,7 +193,7 @@ export default defineConfig({
text: "AWS インフラリソース",
items: [
{
text: "Home",
text: "Introduction",
link: "/documents/forAWSResource/",
},
{
Expand All @@ -206,7 +206,7 @@ export default defineConfig({
text: "OpenAPI Specification規約",
items: [
{
text: "Home",
text: "Introduction",
link: "/documents/forOpenAPISpecification/",
},
{
Expand All @@ -223,7 +223,7 @@ export default defineConfig({
text: "Gitブランチフロー規約",
items: [
{
text: "Home",
text: "Introduction",
link: "/documents/forGitBranch/",
},
{
Expand All @@ -236,7 +236,7 @@ export default defineConfig({
text: "Markdown設計ドキュメント規約",
items: [
{
text: "Home",
text: "Introduction",
link: "/documents/forMarkdown/",
},
{
Expand All @@ -249,7 +249,7 @@ export default defineConfig({
text: "Slack利用ガイドライン",
items: [
{
text: "Home",
text: "Introduction",
link: "/documents/forSlack/",
},
{
Expand Down
2 changes: 1 addition & 1 deletion .vitepress/theme/components/PageInfo.vue
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export default {
},
},
mounted() {
if(import.meta.env.SSR) return;
if (import.meta.env.SSR) return;
loadScript();
},
};
Expand Down
8 changes: 6 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
{
"eslint.validate": ["javascript", "javascriptreact", "vue"],
"eslint.workingDirectories": ["./", "./.vitepress"],
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
},
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
"editor.formatOnSave": true,
"[markdown]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
},
"markdown.extension.tableFormatter.enabled": false
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,10 @@ head:

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

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

:::


## 前提条件

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

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

Expand Down
2 changes: 1 addition & 1 deletion documents/forAWSResource/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebarDepth: 4
author: フューチャー株式会社
layout: home
hero:
name: AWSインフラ命名規約
name: AWSインフラ命名規約
tagline: Future Enterprise Naming Convention Standards for AWS infrastructure resource
actions:
- theme: brand
Expand Down
174 changes: 87 additions & 87 deletions documents/forGitBranch/commit_message_rule.md
Original file line number Diff line number Diff line change
@@ -1,87 +1,87 @@
---
sidebarDepth: 4
title: コミットメッセージ規約
author: フューチャー株式会社
---

# コミットメッセージ規約

Gitのコミットメッセージにの書式についてルール化することで、コミットの目的がわかりやすくなる、履歴からのトラッキングの容易になる利点がある。

本規約のコミットメッセージの書式としては、`Conventional Commits`をベースとした規約としている。

以下の形式でコミットメッセージを記載することとする。

```md
<type>: <subject> <gitmoji>
```

コミットメッセージは
type、subject、gitmojiの最大3つの要素から構成され、それぞれは後述する書式に従うものとする。
この中でも、type、subjectについては必須とし、ほかの要素についてはプロジェクトの運用にしたがい任意とする。

## type

typeについては必須の要素となり、以下のいずれかを選択するものとする。

| type | 説明 |
|--------|--------------------------------------------------------------------------------------|
| `feat` | 新機能の追加 |
| `fix` | バグの修正 |
| `docs` | ドキュメンテーションの更新 |
| `refactor` | リファクタリング|

## subject

subjectについては必須の要素となり、変更内容を簡潔に記載するものとする。
issue idについては、PRから参照する運用を想定し、コミットメッセージの必須要素とはしないこととする。

## gitmoji

gitmojiについては任意の要素となり、変更内容を視認しやすい絵文字の使用を可能とする。

変更内容と選択される絵文字の対応については厳密とせず、開発者が任意に選択するものとする。

type(feat, fix, docs, refactorなど)に基づく、選択例を以下に示す。

```txt
==== Emojis ====
:ambulance: 🚑致命的なバグ修正(fix)
:bug: 🐛バグ修正(fix)
:+1: 👍機能改善・機能修正(fix)
:cop: 👮セキュリティ関連の修正(fix)
:art: 🎨レイアウト関連の修正(fix)
:green_heart: 💚テストやCIの修正・改善(fix)
:wrench: 🔧設定ファイルの修正(fix)
:building_construction: 🏗️アーキテクチャの変更(fix)
:tada: 🎉大きな機能追加(feat)
:sparkles: ✨部分的な機能追加(feat)
:up: 🆙依存パッケージ等のアップデート(feat)
:memo: 📝ドキュメント修正(docs)
:bulb: 💡ソースコードへのコメント追加や修正(docs)
:lipstick: 💄Lintエラーの修正やコードスタイルの修正(refactor)
:recycle: ♻️リファクタリング(refactor)
:fire: 🔥コードやファイルの削除(refactor)
:rocket: 🚀パフォーマンス改善(refactor)
```

## コミットメッセージ例

上記のルールに従った、コミットメッセージのサンプルは以下のようなものとなる。
以下のようなコミットをルールとすることで、変更内容を視覚的に把握しやすくなる利点がある。

```txt
feat: カレンダー機能の追加 🎉
```

```txt
fix: メモリリークの修正 🚑
```

```txt
docs: デプロイフローをドキュメント化 📝
```

```txt
refactor: Lintエラーの修正 💄
```
---
sidebarDepth: 4
title: コミットメッセージ規約
author: フューチャー株式会社
---

# コミットメッセージ規約

Gitのコミットメッセージにの書式についてルール化することで、コミットの目的がわかりやすくなる、履歴からのトラッキングの容易になる利点がある。

本規約のコミットメッセージの書式としては、`Conventional Commits`をベースとした規約としている。

以下の形式でコミットメッセージを記載することとする。

```md
<type>: <subject> <gitmoji>
```

コミットメッセージは
type、subject、gitmojiの最大3つの要素から構成され、それぞれは後述する書式に従うものとする。
この中でも、type、subjectについては必須とし、ほかの要素についてはプロジェクトの運用にしたがい任意とする。

## type

typeについては必須の要素となり、以下のいずれかを選択するものとする。

| type | 説明 |
| ---------- | -------------------------- |
| `feat` | 新機能の追加 |
| `fix` | バグの修正 |
| `docs` | ドキュメンテーションの更新 |
| `refactor` | リファクタリング |

## subject

subjectについては必須の要素となり、変更内容を簡潔に記載するものとする。
issue idについては、PRから参照する運用を想定し、コミットメッセージの必須要素とはしないこととする。

## gitmoji

gitmojiについては任意の要素となり、変更内容を視認しやすい絵文字の使用を可能とする。

変更内容と選択される絵文字の対応については厳密とせず、開発者が任意に選択するものとする。

type(feat, fix, docs, refactorなど)に基づく、選択例を以下に示す。

```txt
==== Emojis ====
:ambulance: 🚑致命的なバグ修正(fix)
:bug: 🐛バグ修正(fix)
:+1: 👍機能改善・機能修正(fix)
:cop: 👮セキュリティ関連の修正(fix)
:art: 🎨レイアウト関連の修正(fix)
:green_heart: 💚テストやCIの修正・改善(fix)
:wrench: 🔧設定ファイルの修正(fix)
:building_construction: 🏗️アーキテクチャの変更(fix)
:tada: 🎉大きな機能追加(feat)
:sparkles: ✨部分的な機能追加(feat)
:up: 🆙依存パッケージ等のアップデート(feat)
:memo: 📝ドキュメント修正(docs)
:bulb: 💡ソースコードへのコメント追加や修正(docs)
:lipstick: 💄Lintエラーの修正やコードスタイルの修正(refactor)
:recycle: ♻️リファクタリング(refactor)
:fire: 🔥コードやファイルの削除(refactor)
:rocket: 🚀パフォーマンス改善(refactor)
```

## コミットメッセージ例

上記のルールに従った、コミットメッセージのサンプルは以下のようなものとなる。
以下のようなコミットをルールとすることで、変更内容を視覚的に把握しやすくなる利点がある。

```txt
feat: カレンダー機能の追加 🎉
```

```txt
fix: メモリリークの修正 🚑
```

```txt
docs: デプロイフローをドキュメント化 📝
```

```txt
refactor: Lintエラーの修正 💄
```
Loading

0 comments on commit 48d4deb

Please sign in to comment.