Merge pull request #247 from DroidKaigi/takahirom/add-step-by-step-gu…

…ide-to-contributing/2024-08-10

Add a Step-by-Step Guide for Contributing

CONTRIBUTING.ja.md

@@ -2,24 +2,61 @@
 
 あなたのコントリビュートをお待ちしております！
 
-## コントリビュート方法
+## ステップバイステップのコントリビュート方法
 
-### タスクの見つけ方
+### 1. ソースコードをダウンロードする
 
-タスク管理にGitHub Issueを使っています。こちらでコントリビュートしたいIssueをお探しください。[`welcome contribute` または `easy`のラベルがついているIssue](https://github.com/DroidKaigi/conference-app-2024/issues?q=is%3Aopen+is%3Aissue+label%3A%22welcome+contribute%22%2Ceasy+no%3Aassignee)は、初めてのコントリビュートにおすすめです。
+まずリポジトリをローカルにダウンロードして実行することで、アプリを試してみましょう。アプリの使い方や機能を理解するのに役立ちます。
+リポジトリの右上にある `Fork` ボタンをクリックしてください。これであなたのアカウントにリポジトリがコピーされます。
+
+![image](https://github.com/user-attachments/assets/39aa034e-052f-4084-b864-a3214841752c)
+
+そのあと、以下のコマンドを実行してください。
+
+```bash
+git clone https://github.com/[あなたのアカウント]/conference-app-2024
+```
+
+これでリポジトリがあなたのPCにダウンロードされます。
+
+### 2. アプリを実行してみる
+
+Android Studioを開いて、"Open"からダウンロードしたリポジトリを開いてください。Android Studioは[こちら](https://developer.android.com/studio)からダウンロードできます。最新のバージョンを使ってください。
+
+リポジトリを開くと、Syncが始まります。Gradleの同期が終わるまでお待ちください。
+
+`app-android` モジュールをビルドして実行します。Android Studio上の実行ボタンをクリックしてください。
+
+![image](https://github.com/user-attachments/assets/66f3f0c8-ee18-4961-9c3b-7a808cd2a3b4)
+
+### 3. タスクを見つける
+
+タスク管理にGitHub Issueを使っています。こちらでコントリビュートしたいIssueをお探しください。[`contributions welcome` または `easy`のラベルがついているIssue](https://github.com/DroidKaigi/conference-app-2024/issues?q=is%3Aissue+is%3Aopen+label%3A%22difficulty%3Aeasy+%F0%9F%8C%B1%22+label%3A%22contributions+welcome%22+)は、初めてのコントリビュートにおすすめです。
 
 IssueがないPull Requestでも大丈夫です。その場合はPull Requestに理由、原因、解決策などの詳細をご記入ください。
 
-### コントリビュートの始め方
+### 4. コントリビュートの始める
 
 もし取り組みたいタスクを見つけたら、他の人と重複して作業しないようにするためIssueに ":raising_hand:" などのコメントをしてください。
 なるべく早くいただいたコメントにリアクションしますが、Issueにコメントを書いたらタスクに着手していただいて構いません！
 
-## 議論や提案の方法
+### 5. 開発する
 
-Issueが望ましいですが、もし実装やリファクタリングのための具体的なアイデアなどがありましたらPull Requestも歓迎です。
+アプリのコードを変更し、開発しましょう！
+
+今年採用しているUIツールキットのJetpack Composeについて学びたい方は以下が参考になるので、確認してみてください。
+https://developer.android.com/courses/jetpack-compose/course
+
+コードフォーマットのコマンドは以下の通りです。Android Studioでこのドキュメントを開いて、左側の実行ボタンから実行できます。
 
-## Issueやコメント、レビューで使う言語
+```bash
+./gradlew detekt --auto-correct
+```
+
+### 6. プルリクエストを作成する
+
+変更が完了したら、プルリクエストを作成してください。
+gitのコミットとプッシュを行い、GitHubのUI ( https://github.com/[あなたのアカウント]/conference-app-2024 )からプルリクエストを作成します。
 
 私たちはIssue、コメント、レビューでは英語を使います。
 
@@ -29,6 +66,14 @@ Issueが望ましいですが、もし実装やリファクタリングのため
 
 非英語圏のみなさまへ、DroidKaigiの運営メンバーもみな英語が得意というわけではありません。英語でのコミュニケーションを恐れず挑戦してみてください！ :smile:
 
+### 7. コードレビュー、マージ
+
+プルリクエストの作成が終わるとコードレビューが始まります。修正をお願いすることがあれば、差分にインラインコメントがつきますので適宜確認をしましょう。修正が完了したらマージされます。 👍
+
+## 議論や提案の方法
+
+Issueが望ましいですが、もし実装やリファクタリングのための具体的なアイデアなどがありましたらPull Requestも歓迎です。
+
 ## NOTE
 
 分からないことがありましたら何でも聞いてください！

CONTRIBUTING.md

@@ -1,34 +1,81 @@
 # Contributing
 
-We welcome your contribution!
+We welcome your contributions!
 
-## How to contribute
+## Step-by-Step Guide to Contributing
 
-### Finding tasks
+### 1. Download the Source Code
 
-We use GitHub issues to manage the tasks. Please check here for issues you would like to contribute to. [`welcome contribute` or `easy` are good labels](https://github.com/DroidKaigi/conference-app-2024/issues?q=is%3Aopen+is%3Aissue+label%3A%22welcome+contribute%22%2Ceasy+no%3Aassignee) to check for the first contribution.
+First, download the repository locally and try out the app. This will help you understand how the app works and its features.
+Click the `Fork` button at the top right of the repository. This will create a copy of the repository in your account.
 
-Of course, we also accept Pull Requests which don't have an issue. However, in this case please make sure you explain the motivation, cause, solution, etc in the PR description.
+![image](https://github.com/user-attachments/assets/39aa034e-052f-4084-b864-a3214841752c)
 
-### Start contributing
+Then, run the following command:
 
-If you find a task you want to work on, please comment on the issue to prevent conflicts. We'll reply as soon as possible, but you don't need to wait for our reaction, you can start working on the task once you have commented on the issue!
+```bash
+git clone https://github.com/[your-account]/conference-app-2024
+```
 
-## How to submit a proposal or start a discussion
+This will download the repository to your PC.
 
-Issues are preferable, but PRs are also welcome if you have a concrete idea to implement/refactor something. 
+### 2. Run the App
 
-## Languages
+Open Android Studio and select "Open" to open the downloaded repository. You can download Android Studio from [here](https://developer.android.com/studio). Please use the latest version.
 
-We use English for issues, comments, and reviews.
+When you open the repository, the sync will start. Please wait for the Gradle sync to complete.
 
-English is preferable however; it would be okay in Japanese if you do not want to use English for some reasons. 
-Unfortunately, only English and Japanese are acceptable for us because of our language ability. Thank you for your understanding. JFYI, We at DroidKaigi Committee consists of Japanese speakers and English speakers. 
+Build and run the `app-android` module. Click the run button in Android Studio.
 
-For non-English speakers, some of DroidKaigi Committee members are not fluent English speakers so don't be afraid of communicating in English. :)
+![image](https://github.com/user-attachments/assets/66f3f0c8-ee18-4961-9c3b-7a808cd2a3b4)
+
+### 3. Find a Task
+
+We use GitHub Issues for task management. Please look for an Issue you'd like to contribute to. [Issues labeled `contributions welcome` or `easy`](https://github.com/DroidKaigi/conference-app-2024/issues?q=is%3Aissue+is%3Aopen+label%3A%22difficulty%3Aeasy+%F0%9F%8C%B1%22+label%3A%22contributions+welcome%22+) are recommended for first-time contributors.
+
+Pull Requests without an Issue are also welcome. In that case, please include details such as the reason, cause, and solution in your Pull Request.
+
+### 4. Start Contributing
+
+If you've found a task you'd like to work on, please comment on the Issue with ":raising_hand:" or similar to avoid duplicate work.
+We'll try to respond to your comment as soon as possible, but feel free to start working on the task after commenting on the Issue!
+
+### 5. Develop
+
+Make changes to the app's code and start developing!
+
+If you want to learn about Jetpack Compose, the UI toolkit we're using this year, you might find the following helpful:
+https://developer.android.com/courses/jetpack-compose/course
+
+The command for code formatting is as follows. You can run it by opening this document in Android Studio and clicking the run button on the left:
+
+```bash
+./gradlew detekt --auto-correct
+```
+
+### 6. Create a Pull Request
+
+Once you've completed your changes, please create a pull request.
+Commit and push your git changes, then create a pull request from the GitHub UI (https://github.com/[your-account]/conference-app-2024).
+
+We use English for Issues, comments, and reviews.
+
+If possible, please use English, but Japanese is also fine.
+Please note that we only support English and Japanese in this repository.
+※For your reference, the DroidKaigi organizing team consists of both Japanese and English speakers.
+
+To non-native English speakers, not all DroidKaigi organizers are proficient in English either. Don't be afraid to try communicating in English! :smile:
+
+### 7. Code Review and Merge
+
+Once you've created your pull request, the code review process will begin. If we need to request changes, we'll add inline comments to the diff, so please check them as needed. Once the changes are complete, your pull request will be merged. 👍
+
+## How to Discuss and Propose
+
+While Issues are preferred, if you have specific ideas for implementation or refactoring, Pull Requests are also welcome.
 
 ## NOTE
 
-Please don't hesitate to ask questions. 
+If you have any questions, please don't hesitate to ask!
 
-We would like you to enjoy contributions, learn many things, share your knowledge and enjoy DroidKaigi. Thanks.
+Enjoy contributing, learn a lot, share knowledge, and have fun at DroidKaigi!

README.md

@@ -23,9 +23,13 @@ You can try the app on your device by clicking the button below.
 
 ## Contributing
 
-We always welcome any and all contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
+We always welcome contributions!
 
-For Japanese speakers, please see [CONTRIBUTING.ja.md](CONTRIBUTING.ja.md).
+For a detailed step-by-step guide on how to contribute, please see [CONTRIBUTING.md](CONTRIBUTING.md). This guide will walk you through the process from setting up your environment to submitting your pull request.
+
+For Japanese speakers, a Japanese version of the contribution guide is available at [CONTRIBUTING.ja.md](CONTRIBUTING.ja.md).
+
+コントリビューションの詳細な手順については、[CONTRIBUTING.ja.md](CONTRIBUTING.ja.md)をご覧ください。初めての方でも分かりやすいステップバイステップのガイドを用意しています。
 
 ## Requirements
 Stable Android Studio Koala or higher. You can download it from [this page](https://developer.android.com/studio).