Skip to content

Commit 546c9b4

Browse files
authored
Markdown設計ドキュメント規約の導線を復活 (#211)
* change Require conversation resolution before merging * Markdownガイドラインの導線復活
1 parent 692389e commit 546c9b4

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

documents/forGitBranch/git_branch_standards.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -726,7 +726,7 @@ Branch protection rules にdevelop, mainなど永続的なブランチに保護
726726
| | Dismiss stale pull request approvals when new commits are pushed | - | レビュー承認後のPushで再承認を必要とするかだが、レビュー運用上に支障となることも多く、チェックを外す |
727727
| | Require status checks to pass before merging | ✅️ | CIの成功を条件とする |
728728
| | Require branches to be up to date before merging | 任意 | CIパイプラインのワークフロー名を指定 |
729-
| | Require conversation resolution before merging | ✅️ | レビューコメントがすべて解決していることを条件とする |
729+
| | Require conversation resolution before merging | - | レビューコメントがすべて解決していることを条件とする。チェックを外す |
730730
| | Require signed commits | ✅️ | 署名付きコミットを必須化し、セキュアな設定にする |
731731
| | Require linear history | ✅️/- | mainブランチの場合はOFFとするが、developの場合はSquash mergeを求めるため有効にする |
732732
| | Do not allow bypassing the above settings | ✅️ | パイパスを許容しない |

documents/forMarkdown/markdown_design_document.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ Markdown に限った話では無いが、どういった内容を設計書に
3737
::: warning 有志で作成したドキュメントである
3838

3939
- フューチャーアーキテクトには多様なプロジェクトが存在し、それぞれの状況に合わせて工夫された運営方針が存在する。本規約はフューチャーアーキテクトの全ての部署/プロジェクトで利用されているわけではなく、有志が観点を持ち寄って新たに整理したものである。相容れない部分があればその領域を書き換えて利用することを想定している
40-
- 自社のセキュリティポリシーや外部サービス利用ポリシーがある場合は、そちらを優先すること
41-
- Slack Enterprise Grid/Google Workspaceを利用しているため、それらの機能を前提にしている記述がある
4240

4341
:::
4442

index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,11 @@ hero:
2222
text: Gitブランチフロー規約
2323
link: ./documents/forGitBranch/
2424
- theme: alt
25-
text: Slack利用規約
25+
text: Slack利用ガイドライン
2626
link: ./documents/forSlack/
27+
- theme: alt
28+
text: Markdown設計ドキュメント規約
29+
link: ./documents/forMarkdown/
2730
features:
2831
- title: Readability
2932
details: ソースコードの可読性を高く保つことで、保守性・拡張性の高いソフトウェアを作ることができます。 しかし、可読性の指標は複数あり、デベロッパーごとに判断がブレ、それぞれのスタイルで記述すると、ソフトウェア全体で見たときの可読性が下がってしまいます。 本コーディング規約は、コーディング時の判断のブレを防ぎます。

0 commit comments

Comments
 (0)