|
|
@@ -195,17 +195,22 @@ Documentation
|
|
|
Contribution
|
|
|
============
|
|
|
|
|
|
-For development
|
|
|
+Found a Bug?
|
|
|
-------------
|
|
|
|
|
|
-### Build and Run the app
|
|
|
+If you found a bug in the source code, you can help us by
|
|
|
+[submitting an issue][issues] to our [GitHub Repository][growi]. Even better, you can
|
|
|
+[submit a Pull Request][pulls] with a fix.
|
|
|
+
|
|
|
+Missing a Feature?
|
|
|
+-------------------
|
|
|
+
|
|
|
+You can *request* a new feature by [submitting an issue][issues] to our GitHub
|
|
|
+Repository. If you would like to *implement* a new feature, firstly please submit the issue with your proposal to make sure we can confirm it. Please clarify what kind of change you would like to propose.
|
|
|
|
|
|
-1. `clone` this repository
|
|
|
-2. `yarn` to install all dependencies
|
|
|
- * DO NOT USE `npm install`
|
|
|
-3. `npm run build` to build client app
|
|
|
-4. `npm run server` to start the dev server
|
|
|
-5. Access `http://0.0.0.0:3000`
|
|
|
+* For a **Major Feature**, firstly open an issue and outline your proposal so it can be discussed.
|
|
|
+It also allows us to coordinate better, prevent duplication of work and help you to create the change so it can be successfully accepted into the project.
|
|
|
+* **Small Features** can be created and directly [submitted as a Pull Request][pulls].
|
|
|
|
|
|
Translation
|
|
|
--------------
|
|
|
@@ -222,26 +227,8 @@ https://docs.gitbook.com/v2-changes/important-differences#multi-language-books
|
|
|
|
|
|
*We have to wait until it is implemented.*
|
|
|
|
|
|
-
|
|
|
-Found a Bug?
|
|
|
--------------
|
|
|
-
|
|
|
-If you found a bug in the source code, you can help us by
|
|
|
-[submitting an issue][issues] to our [GitHub Repository][growi]. Even better, you can
|
|
|
-[submit a Pull Request][pulls] with a fix.
|
|
|
-
|
|
|
-Missing a Feature?
|
|
|
--------------------
|
|
|
-
|
|
|
-You can *request* a new feature by [submitting an issue][issues] to our GitHub
|
|
|
-Repository. If you would like to *implement* a new feature, firstly please submit the issue with your proposal to make sure we can confirm it. Please clarify what kind of change you would like to propose.
|
|
|
-
|
|
|
-* For a **Major Feature**, firstly open an issue and outline your proposal so it can be discussed.
|
|
|
-It also allows us to coordinate better, prevent duplication of work and help you to create the change so it can be successfully accepted into the project.
|
|
|
-* **Small Features** can be created and directly [submitted as a Pull Request][pulls].
|
|
|
-
|
|
|
-Language
|
|
|
----------
|
|
|
+Language on GitHub
|
|
|
+------------------
|
|
|
|
|
|
You can write issues and PRs in English or Japanese.
|
|
|
|
Yuki Takei