Skip to content
Closed
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
60 changes: 30 additions & 30 deletions .github/commit-convention.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,50 @@
## Git Commit Message Convention
## Gitのコミット・メッセージに関する規約

> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
> これは[Angularのコミット規約](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)を参考にしたものです。

#### TL;DR:
#### 要約:

Messages must be matched by the following regex:
メッセージは以下の正規表現でマッチさせる必要があります:

```js
/^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,50}/
```

#### Examples
####

Appears under "Features" header, `theme` subheader:
"Features"ヘッダーの`theme`サブヘッダーに表示されます:

```
feat(theme): add home page feature
feat(theme): add home page feature(訳: ホームページ機能の追加です)
```

Appears under "Bug Fixes" header, `theme` subheader, with a link to issue #28:
"BugFixes"ヘッダーの`theme`サブヘッダーに、issue #28へのリンクとともに表示されます:

```
fix(theme): remove underline on sidebar hover style
fix(テーマ): remove underline on sidebar hover style(訳: サイドバーのホバースタイルから下線を取り除きます)

close #28
```

Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
"Performance Improvements"ヘッダーの下に表示され、"Breaking Changes"の下には変更点の説明とともに表示されます:

```
perf: improve store getters performance by removing 'foo' option
perf: improve store getters performance by removing 'foo' option(訳: 'foo'オプションを削除することで、ストアゲッターのパフォーマンスを改善します)

BREAKING CHANGE: The 'foo' option has been removed.
BREAKING CHANGE: The 'foo' option has been removed.(訳: 'foo'オプションは削除されました。)
```

The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
以下のコミットとコミット`667ecc1`は同じリリースの場合、changelogに表示されません。そうでない場合、差し戻しコミットは"Reverts"ヘッダーの下に表示されます。

```
revert: feat(theme): add home page feature
revert: feat(theme): add home page feature(訳: ホームページ機能の追加)

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
```

### Full Message Format
### 完全なメッセージ・フォーマット

A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
コミット・メッセージは**header****body****footer**で構成されます。ヘッダーには **type****scope****subject** があります:

```
<type>(<scope>): <subject>
Expand All @@ -54,38 +54,38 @@ A commit message consists of a **header**, **body** and **footer**. The header h
<footer>
```

The **header** is mandatory and the **scope** of the header is optional.
**header**は必須であり、ヘッダーの**scope**はオプションです。

### Revert

If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
前のコミットを取り消す場合は、`revert: `で始まり、その後に取り消すコミットのheaderを続けます。本文では、`This reverts commit <hash>.` (hashは差し戻されるコミットのSHA)と記述します。

### Type

If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
prefixが`feat``fix``perf`の場合、変更履歴に表示されます。しかし、[BREAKING CHANGE](#footer)があれば、そのコミットは常に変更履歴に表示されます。

Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
その他の接頭辞は自由です。推奨されるprefixは`docs``chore``style``refactor`および`test`です。

### Scope

The scope could be anything specifying the place of the commit change. For example `theme`, `compiler`, `ssr`, etc...
scopeはコミットの変更箇所を指定するものであれば何でも構いません。例えば`theme``compiler``ssr`などです。

### Subject

The subject contains a succinct description of the change:
subjectには、変更の簡潔な説明が含まれています:

- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- no dot (.) at the end
- 現在形、もしくは命令形を使う: "changed"または"changes"ではなく、"change"
- 最初の文字を大文字にしない
- 最後にドット(.)がない

### Body

Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
The body should include the motivation for the change and contrast this with previous behavior.
**subject**と同じように、現在形、もしくは命令形を使う。: "changed"または"changes"ではなく"change"
本文には、changeの説明を盛り込み、以前の挙動と対比させる。

### Footer

The footer should contain any information about **Breaking Changes** and is also the place to
reference GitHub issues that this commit **Closes**.
フッターには、**Breaking Changes** に関する情報を記述します。
また、このコミットが**Closes**するGithubのissueを参照する箇所でもあります。

**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
**Breaking Changes**`BREAKING CHANGE:`という単語とスペースまたは2つの改行で始まります。コミット・メッセージの残りはこのために使われます。
42 changes: 21 additions & 21 deletions .github/contributing.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,50 @@
# VitePress Contributing Guide
# VitePress コントリビュート・ガイド

Hi! We're really excited that you are interested in contributing to VitePress. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
こんにちは!VitePressへのコントリビュートにご興味をお持ちいただき、誠にありがとうございます。コントリビュートの前に、以下のガイドラインを必ずお読みください:

- [Code of Conduct](https://github.com/vuejs/vue/blob/dev/.github/CODE_OF_CONDUCT.md)
- [Pull Request Guidelines](#pull-request-guidelines)
- [行動規範](https://github.com/vuejs/vue/blob/dev/.github/CODE_OF_CONDUCT.md)
- [Pull Request ガイドライン](#pull-request-guidelines)

## Pull Request Guidelines
## Pull Request ガイドライン

- Checkout a topic branch from the relevant branch, e.g. `main`, and merge back against that branch.
- 関連するブランチ、例えば`main`からtopic branchをcheckoutし、そのbranchに対してmerge backします。

- If adding a new feature:
- 新しい機能を追加する場合:

- Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
- この機能を追加する説得力のある理由を提示してください。理想的には、まず提案課題を開き、それを承認してもらってから取り組むべきです。

- If fixing bug:
- Bugを修正する場合:

- Provide a detailed description of the bug in the PR. Live demo preferred.
- PRにbugの詳細な説明を記入してください。Live demoが望ましいです。

- It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
- PRの作業中に小さなコミットが複数あってもかまいません。GitHubはmergeする前にそれらを自動的につぶしてくれます。

- Commit messages must follow the [commit message convention](./commit-convention.md) so that changelogs can be automatically generated.
- コミット・メッセージは[コミット・メッセージ規約](./commit-convention.md)に従わなければならないので、changelogが自動的に生成されます。

## Development Setup
## 開発準備

You will need [pnpm](https://pnpm.io)
[pnpm](https://pnpm.io)が必要です。

After cloning the repo, run:
repoをcloneしたら、実行する:

```sh
# install the dependencies of the project
# プロジェクトの依存関係をインストールする
$ pnpm install
# setup git hooks
# git hookの設定
$ pnpm simple-git-hooks
```

### Setup VitePress Dev Environment
### VitePress開発環境のセットアップ

The easiest way to start testing out VitePress is to tweak the VitePress docs. You may run `pnpm run docs` to boot up VitePress documentation site locally, with live reloading of the source code.
VitePressのテストを始める最も簡単な方法は、VitePressのドキュメントを調整することです。`pnpm run docs`を実行すると、VitePressのドキュメント・サイトがlocalで起動し、ソースコードがliveでreloadされます。

```sh
$ pnpm run docs
```

After executing the above command, visit http://localhost:5173 and try modifying the source code. You'll get live update.
上記のコマンドを実行した後、http://localhost:5173をクリックし、ソースコードを変更してみてください。live updateが実行されます。

If you don't need docs site up and running, you may start VitePress local dev environment with `pnpm run dev`.
ドキュメント・サイトを立ち上げる必要がない場合は、`pnpm run dev`でVitePressのlocal開発環境を立ち上げることができます。

```sh
$ pnpm run dev
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@

---

VitePress is a Vue-powered static site generator and a spiritual successor to [VuePress](https://vuepress.vuejs.org), built on top of [Vite](https://github.com/vitejs/vite).
VitePressはVueを搭載した静的サイトジェネレーターで、[Vite](https://github.com/vitejs/vite)の上に構築された[VuePress](https://vuepress.vuejs.org)の精神的後継です。

## Documentation

To check out docs, visit [vitepress.dev](https://vitepress.dev).
ドキュメントをチェックされたい方は、[vitepress.dev](https://vitepress.dev)をご覧ください。

## Changelog

Detailed changes for each release are documented in the [CHANGELOG](https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md).
各リリースの詳細な変更点は、[CHANGELOG](https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md)に記載されています。

## Contribution

Please make sure to read the [Contributing Guide](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md) before making a pull request.
プルリクエストを行う前に、必ず[Contributing Guide](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md)を読んでください。

## License

Expand Down
Loading