Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup lint #11

Merged
merged 9 commits into from
Oct 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/check-pull-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Check Pull Request

on:
pull_request:
types: [opened, synchronize, reopened]

jobs:
check-pull-request:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
- name: Install Node.js
uses: actions/setup-node@v3
with:
node-version: 18
cache: "npm"
- name: Install Dependencies
run: npm install
- name: Lint
run: npm run lint
20 changes: 20 additions & 0 deletions .markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"config": {
"ul-style": {
"style": "dash"
},
"hr-style": {
"style": "---"
},
"code-block-style": {
"style": "fenced"
},
"code-fence-style": {
"style": "backtick"
},
"line-length": false,
"MD024": false,
"MD025": false,
"no-inline-html": false
}
}
2 changes: 2 additions & 0 deletions .textlintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Ignore file:
docs/01-Basic/aoa.md
50 changes: 50 additions & 0 deletions .textlintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
{
"plugins": {
"@textlint/markdown": {
"extensions": [
".md"
]
}
},
"rules": {
"prh": {
"rulePaths": [
"./node_modules/textlint-rule-preset-icsmedia/dict/prh.yml"
]
},
"preset-jtf-style": {
"3.1.1.全角文字と半角文字の間": false,
"3.1.2.全角文字どうし": false,
"4.2.7.コロン(:)": false,
"4.3.1.丸かっこ()": false
},
"preset-ja-spacing": {
"ja-space-around-code": {
"before": false,
"after": false
},
"ja-space-between-half-and-full-width": {
"space": "always"
}
},
"preset-japanese": true,
"preset-ja-technical-writing": {
"max-kanji-continuous-len": false,
"no-exclamation-question-mark": {
"allowFullWidthExclamation": true,
"allowFullWidthQuestion": true
},
"no-doubled-joshi": {
"strict": false,
"allow": [
"も",
"や",
"か"
]
}
}
},
"filters": {
"comments": true
}
}
33 changes: 15 additions & 18 deletions docs/01-Basic/governing_documents_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ sidebar_position: 2

### 第1条(目的)

本規程は、当法人における諸規程の制定、公布、改正及び廃止に当たって遵守すべき事項を定め、諸規程を体系的に整備して業務の運営を正確かつ効率的に執行することを目的とする。
本規程は、当法人における諸規程の制定、公布、改正および廃止に当たって遵守すべき事項を定め、諸規程を体系的に整備して業務の運営を正確かつ効率的に執行することを目的とする。

### 第2条(適用範囲)

#### 1

本規程は、当法人で制定され、[当リポジトリ](https://regulations.sre-next.org)の `docs` ディレクトリ配下に配置される、すべての規程、その他ガイドライン等のドキュメント(以下「諸規程」という)に適用する。
本規程は、当法人で制定され、[当リポジトリ](https://regulations.sre-next.org)の`docs`ディレクトリ配下に配置される、すべての規程、その他ガイドライン等のドキュメント(以下「諸規程」という)に適用する。

#### 2

Expand Down Expand Up @@ -47,11 +47,11 @@ sidebar_position: 2

#### 3

同位規程の内容が相互に矛盾し、又は抵触するときは、制定及び改定時期が最も新しい規程を優先する
同位規程の内容が相互に矛盾し、又は抵触するときは、制定および改定時期がもっとも新しい規程を優先する

### 第5条(委任)

上位規程は、その規程の権限範囲内において下位規程に対して詳細規程を委任することができる
上位規程は、その規程の権限範囲内において下位規程に対して詳細規程を委任できる

### 第6条(業務処理の規程化)

Expand Down Expand Up @@ -81,7 +81,7 @@ sidebar_position: 2

#### 2

諸規程は、当法人の公益性を鑑み、当法人の構成員(理事・社員・職員・会員)でなくとも、無償業務委託を結んだイベントスタッフを初めとした当法人関係者も制定・改廃の原案を作成し、起案することができる
諸規程は当法人の公益性を鑑み、当法人の構成員(理事・社員・職員・会員)でなくとも、無償業務委託を結んだイベントスタッフを初めとした当法人関係者も制定・改廃の原案を作成し、起案できる

### 第10条(形式的要件・整合性の検討)

Expand All @@ -91,7 +91,7 @@ sidebar_position: 2

#### 2

起案は[規程・ガイドライン集の更新ガイドライン](99-Others/develop_regulations_web_site.md)に従い、GitHubのプルリクエストを利用して行うこととする
起案は[規程・ガイドライン集の更新ガイドライン](99-Others/develop_regulations_web_site.md)に従い、GitHub のプルリクエストを利用して行うこととする

#### 3

Expand All @@ -101,27 +101,27 @@ sidebar_position: 2

#### 1

諸規程の制定・改廃の決定は、規程管理者のうち最低1名以上のレビューをもって決定するものとする
諸規程の制定・改廃の決定は、規程管理者のうち最低 1 名以上のレビューをもって決定するものとする

#### 2

規程管理者が起案者となる場合は、起案者以外の規程管理者からのレビューを必要とする。

#### 3

規程管理者内で意見の相違が出た場合は協議を行い、最終決定は規程管理責任者が行うものとする。
規程管理者内で意見の相違が出た場合は協議し、最終決定は規程管理責任者が行うものとする。

## 第3章 公布・保管

### 第12条(公布)

#### 1

規程管理者のレビューを受けた諸規程は規程管理者もしくは起案者によって速やかに `main` ブランチにマージし、[公開サイト](https://regulations.sre-next.org)にて一般公開する。
規程管理者のレビューを受けた諸規程は規程管理者もしくは起案者によって速やかに`main`ブランチにマージし、[公開サイト](https://regulations.sre-next.org)にて一般公開する。

#### 2

制定日・施行日・版は諸規程の文書内には原則記載しないものとし、[リポジトリ](https://github.com/sre-next/corporate-regulations)の `main` ブランチへのコミットログの日時をもって制定日・施行日とする
制定日・施行日・版は諸規程の文書内には原則記載しないものとし、[リポジトリ](https://github.com/sre-next/corporate-regulations)の`main`ブランチへのコミットログの日時をもって制定日・施行日とする

### 第13条(効力)

Expand All @@ -131,31 +131,28 @@ sidebar_position: 2

#### 2

現行規程を廃止し、新規程を制定したときは、旧規程の効力は特に定めがない限り、新規程の施行とともに消滅する。
現行規程を廃止し、新規程を制定したときは、旧規程の効力はとくに定めがない限り、新規程の施行とともに消滅する。

### 第14条(収録・保管・公開)

公布された諸規程は、[リポジトリ](https://github.com/sre-next/corporate-regulations)の `main` ブランチおよび[公開サイト](https://regulations.sre-next.org)に収録・保管・公開するものとする。
公布された諸規程は、[リポジトリ](https://github.com/sre-next/corporate-regulations)の`main`ブランチおよび[公開サイト](https://regulations.sre-next.org)に収録・保管・公開するものとする。

### 第15条(運用)

#### 1

規程管理者は諸規程が公布された際には、遅滞なく法人関係者に周知し、その指導を行うものとする
規程管理者は諸規程が公布された際には、遅滞なく法人関係者に周知し、指導するものとする

#### 2

理事、社員、職員、会員および関係者は、公布された諸規程を厳正に遵守しなければならない。

#### 3

規程管理者及び関係者は、緊密な連絡をとり、諸規程の適正な運用、調整にあたり諸規程の維持促進に努めるものとする。
規程管理者および関係者は、緊密な連絡をとり、諸規程の適正な運用、調整にあたり諸規程の維持促進に努めるものとする。

## 第4章 その他

### 第16条(改廃)

本規程は、第11条に従い規程管理者のうち1名以上のレビューをもって改廃する。


以上
本規程は、第 11 条に従い規程管理者のうち 1 名以上のレビューをもって改廃する。
2 changes: 1 addition & 1 deletion docs/02-Organization/approval.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 2

# 稟議規程

準備中
準備中
2 changes: 1 addition & 1 deletion docs/02-Organization/company_reporting_structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 1

# 決裁権限規程

準備中
準備中
2 changes: 1 addition & 1 deletion docs/02-Organization/internal_audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 3

# 内部監査規程

準備中
準備中
2 changes: 1 addition & 1 deletion docs/03-General_Affairs/document_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 1

# 文書管理規程

準備中
準備中
2 changes: 1 addition & 1 deletion docs/03-General_Affairs/official_seal_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 2

# 印章管理規程

準備中
準備中
8 changes: 2 additions & 6 deletions docs/04-HR/business_travel_expenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# 出張旅費規程

この規程は、当法人の理事及び職員が業務上発生する交通費について、その取扱いと精算方法を定めるものです。
この規程は、当法人の理事および職員が業務上発生する交通費について、その取扱いと精算方法を定めるものです。

## 第 1 条(近郊交通費・駐車場代の取り扱い)

Expand All @@ -31,8 +31,4 @@ sidebar_position: 1

## 第 4 条(精算のタイミング)

管理表に基づいた精算は、原則として年 1 回行います。ただし、精算予定金額が 5 万円を超える場合は、期中でも精算を行うことができます。

## 附則

本規程は、2023 年 7 月 20 日 より施行します。
管理表に基づいた精算は、原則として年 1 回行います。ただし、精算予定金額が 5 万円を超える場合は、期中でも精算できます。
2 changes: 1 addition & 1 deletion docs/05-Accounting/books_and_records.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 1

# 経理規定

準備中
準備中
2 changes: 1 addition & 1 deletion docs/05-Accounting/budget_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 2

# 予算管理規程

準備中
準備中
2 changes: 1 addition & 1 deletion docs/06-Operation_Management/purchasing_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 1

# 購買管理規程

準備中
準備中
2 changes: 1 addition & 1 deletion docs/07-Compliance/anti_social_forces.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 2

# 反社会勢力対応規程

準備中
準備中
2 changes: 1 addition & 1 deletion docs/07-Compliance/compliance.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 5

# コンプライアンス規程

準備中
準備中
2 changes: 1 addition & 1 deletion docs/07-Compliance/information_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 3

# 情報管理規程

準備中
準備中
2 changes: 1 addition & 1 deletion docs/07-Compliance/personal_information_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 1

# 個人情報取扱規程

準備中
準備中
2 changes: 1 addition & 1 deletion docs/07-Compliance/risk_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 4

# リスクマネジメント規程

準備中
準備中
4 changes: 2 additions & 2 deletions docs/99-Others/clame_expenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# 経費精算ガイドライン

このガイドラインは、当法人の理事及び職員が業務上発生する経費について、その精算方法を定めるものです。
このガイドラインは、当法人の理事および職員が業務上発生する経費について、その精算方法を定めるものです。

## 第 1 条(経費精算の原則)

Expand All @@ -19,4 +19,4 @@ sidebar_position: 1

## 附則

本ガイドラインは、2023 年 7 月 20 日 より施行します
本ガイドラインは、2023 年 7 月 20 日より施行します
14 changes: 7 additions & 7 deletions docs/99-Others/develop_regulations_web_site.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,25 @@ sidebar_position: 2

## 公開サイトの構成について

[公開サイト](https://regulations.sre-next.org)はAWS Amplifyでホストされた静的サイトです。[Docusaurus](https://docusaurus.io/)という、ドキュメント公開用の静的サイトジェネレーターを利用しています。
[公開サイト](https://regulations.sre-next.org)は AWS Amplify でホストされた静的サイトです。[Docusaurus](https://docusaurus.io/)という、ドキュメント公開用の静的サイトジェネレーターを利用しています。

## サイト更新の大まかな流れ

[GitHub Flow](https://docs.github.com/ja/get-started/quickstart/github-flow)に準拠して開発を行います
[GitHub Flow](https://docs.github.com/ja/get-started/quickstart/github-flow)に準拠して開発します

mainブランチが[公開サイト](https://regulations.sre-next.org)と同期されるため、原則としてmainブランチからブランチを切ってローカル開発し、mainブランチに対してプルリクエストを出してください
main ブランチが[公開サイト](https://regulations.sre-next.org)と同期されるため、原則として main ブランチからブランチを切ってローカル開発し、main ブランチに対してプルリクエストを出してください

作成するブランチの命名規則は厳密には定めませんが、何を行っているかわかりやすい名前で作成し、他のブランチや過去のブランチ名と極力かぶらないように作成してください。

プルリクエストのレビューおよびマージは原則として法人の理事が実施します。

## ローカル開発

[本リポジトリ](https://github.com/sre-next/corporate-regulations)をクローンし、 `npm install` 後に、 `npm run start` することで、開発環境が立ち上がります。
フォルダ名やドキュメントのファイル名の変更をする際は、一度開発環境を停止してから変更しないとエラーが出ます。
[本リポジトリ](https://github.com/sre-next/corporate-regulations)をクローンし、 `npm install`後に、 `npm run start`することで、開発環境が立ち上がります。
フォルダー名やドキュメントのファイル名の変更をする際は、一度開発環境を停止してから変更しないとエラーが出ます。

Docusaurusを使ったサイト開発方法について、詳しくはDocusaurusの[ドキュメント](https://docusaurus.io/docs/category/getting-started)を参照してください。
Docusaurus を使ったサイト開発方法について、詳しくは Docusaurus の[ドキュメント](https://docusaurus.io/docs/category/getting-started)を参照してください。

## プルリクエスト~デプロイ

ローカルで開発後、mainブランチに対してプルリクエストを出してください。マージされると[公開サイト](https://regulations.sre-next.org)にも自動で変更が反映されます(ビルド&デプロイに数分かかります)
ローカルで開発後、main ブランチに対してプルリクエストを出してください。マージされると[公開サイト](https://regulations.sre-next.org)にも自動で変更が反映されます(ビルド&デプロイに数分かかります)
8 changes: 4 additions & 4 deletions docs/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /

# Home

# このサイトについて
## このサイトについて

このサイトは一般社団法人 SRE NEXT の法人内規程やガイドラインなどの諸規程を整備・公開しています。

Expand All @@ -23,14 +23,14 @@ slug: /

## 用語

本規程・ガイドライン集において、以下のように表記します
本規程・ガイドライン集において、以下のように表記します

| 表記 | 対応 |
| ------ | --------------------- |
| 当法人 | 一般社団法人 SRE NEXT |

## Contribution

本サイトおよび、本サイトに掲載しているドキュメント類について、SRE NEXTのボランティアスタッフをはじめとして、どなたでも改廃の提案が可能です。
本サイトおよび、本サイトに掲載しているドキュメント類について、SRE NEXT のボランティアスタッフをはじめとして、どなたでも改廃の提案が可能です。

[規程・ガイドライン集の更新ガイドライン](99-Others/develop_regulations_web_site.md)を参考にプルリクエストを作成するか、もしくはリポジトリの[Discussions](https://github.com/sre-next/corporate-regulations/discussions)から提案してください。
[規程・ガイドライン集の更新ガイドライン](99-Others/develop_regulations_web_site.md)を参考にプルリクエストを作成するか、もしくはリポジトリの[Discussions](https://github.com/sre-next/corporate-regulations/discussions)から提案してください。
Loading