Skip to content

Commit

Permalink
update CONTRIBUTING.md, add CONTRIBUTING.ja.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Reputeless committed Sep 17, 2023
1 parent 4c42c43 commit 3aff3db
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 4 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
| | |
|--|--|
| [English](CONTRIBUTING.md) | 日本語 |

# Siv3D へのコントリビューションガイド
Siv3D へのコミットを検討いただきありがとうございます。
プロジェクトを改善する取り組みと貢献に感謝いたします。
このガイドでは、コントリビューションをできるだけスムーズに行う方法について説明します。

## ブランチ戦略
2 つのメインブランチがあります。
- [`v6_develop`](https://github.com/Siv3D/OpenSiv3D/tree/v6_develop) 開発用
- [`main`](https://github.com/Siv3D/OpenSiv3D) 安定版

適切なブランチからフォークし、そこで変更を行ってください。
指示がない限り、プルリクエストは `v6_develop` ブランチに送信してください。

## プルリクエストの作成
1. GitHub アカウントにリポジトリをフォークします。
2. フォークしたリポジトリをローカルマシンにクローンします。
3. 機能や修正のために新しいブランチを作成します。
4. [コーディングスタイル](https://siv3d.github.io/ja-jp/develop/coding-style/)に従って変更を行います。
5. [コミットガイドライン](#コミットガイドライン)に従ってコミットします。
6. 変更をフォークにプッシュします。
7. 変更内容を説明するコメントを書いてプルリクエストを作成します。

## コミットガイドライン
- 1 つのプルリクエストに複数のコミットがあっても構いません。
- コミットメッセージは明確で簡潔にしてください。
- 可能であれば、関連する Issue 番号をコミットメッセージで参照してください。

## 議論とコミュニケーション
- 大きな変更や新機能については、作業を開始する前に [Siv3D Discord サーバー](https://siv3d.github.io/ja-jp/community/community/)[GitHub Issues](https://github.com/Siv3D/OpenSiv3D/issues) を通じてメンテナーと相談してください。
- コントリビューションプロセスのどの段階でも、質問や説明を求めることができます。

## ライブラリのビルド
- Siv3D ライブラリを自分でビルドする方法の詳細については、[ビルド手順](https://siv3d.github.io/ja-jp/develop/build/)を参照してください。

39 changes: 35 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
# Contribution Guide
| | |
|--|--|
| English | [日本語](CONTRIBUTING.ja.md) |

## Pull-request
- [`main`](https://github.com/Siv3D/OpenSiv3D) ブランチを fork し、変更を `v6_develop` ブランチに送信してください
- 大きな変更をする場合は、事前に Siv3D Slack や Issues で相談してください
# Contribution Guide for Siv3D
Thank you for considering contributing to Siv3D!
We appreciate your efforts and contributions to improve the project.
This guide provides information on how to make your contributions as smooth as possible.

## Branching Strategy
We have two main branches:
- [`v6_develop`](https://github.com/Siv3D/OpenSiv3D/tree/v6_develop) for development purposes.
- [`main`](https://github.com/Siv3D/OpenSiv3D) for stable releases.

Please fork from the appropriate branch and make your changes there. Submit your pull requests to the `v6_develop` branch unless advised otherwise.

## Making a Pull Request
1. Fork the repository to your GitHub account.
2. Clone the forked repository to your local machine.
3. Create a new branch for your feature or fix.
4. Make your changes, adhering to our [coding standards and guidelines](https://siv3d.github.io/en-us/develop/coding-style/).
5. Commit your changes, following our [commit guidelines](#commit-guidelines).
6. Push your changes to your fork.
7. Open a pull request, providing enough information to help reviewers understand your changes.

## Commit Guidelines
- It's okay to have multiple commits in a single pull request.
- Please make your commit messages clear and concise.
- If possible, reference relevant issue numbers in your commit messages.

## Discussion and Communication
- For major changes or new features, please consult with the maintainers through the [Siv3D Discord server](https://siv3d.github.io/en-us/community/community/) or [GitHub Issues](https://github.com/Siv3D/OpenSiv3D/issues) before starting work.
- Feel free to ask for help or clarification at any stage of your contribution process.

## Building the Library
For details on how to build the Siv3D library on your own, please refer to our [Build Instructions](https://siv3d.github.io/en-us/develop/build/).

0 comments on commit 3aff3db

Please sign in to comment.