فهرست منبع

update docs for github

Yuki Takei 9 سال پیش
والد
کامیت
319449be7c
4فایلهای تغییر یافته به همراه82 افزوده شده و 31 حذف شده
  1. 36 0
      .github/CONTRIBUTING.md
  2. 40 0
      .github/ISSUE_TEMPLATE.md
  3. 5 0
      CHANGES.md
  4. 1 31
      README.md

+ 36 - 0
.github/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+Contributing
+============
+
+Found a Bug?
+-------------
+
+If you find a bug in the source code, you can help us by
+[submitting an issue][issues] to our [GitHub Repository][crowi-plus]. 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, please submit an issue with
+a proposal for your work first, to be sure that we can use it.
+Please consider what kind of change it is:
+
+* For a **Major Feature**, first open an issue and outline your proposal so that it can be
+discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
+and help you to craft the change so that it is successfully accepted into the project.
+* **Small Features** can be crafted and directly [submitted as a Pull Request][pulls].
+
+Language
+---------
+
+Write issues and PRs in Engulish or Japanese.
+
+Discussion
+-----------
+
+If you have something to ask or want to discuss, [join to our Slack team][slackin] and talk about anything, anytime.
+
+
+[issues]: https://github.com/weseek/crowi-plus/issues
+[pulls]: https://github.com/weseek/crowi-plus/pulls

+ 40 - 0
.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,40 @@
+Environment
+------------
+
+- [OS]
+- [node.js] x.x.x
+- [npm] y.y.y
+- [browser] z.z.z
+
+How to reproduce?
+------------------
+
+1. process 1
+
+    ```bash
+    
+    ```
+
+1. process 2
+1. process 3
+
+What's happen?
+---------------
+
+- symptom
+
+```
+Stack Trace
+```
+
+What is the expected result?
+-----------------------------
+
+- 
+- 
+
+Note
+----
+
+- 
+- 

+ 5 - 0
CHANGES.md

@@ -1,6 +1,11 @@
 CHANGES
 ========
 
+## 1.0.6
+
+* Fix: https access to Gravatar
+* Fix: server watching crash with `Error: read ECONNRESET` on Google Chrome
+
 ## 1.0.5
 
 * Feature: Ensure to use Gravatar for profile image

+ 1 - 31
README.md

@@ -157,35 +157,7 @@ Documentation
 Contributing
 ============
 
-Found a Bug?
--------------
-
-If you find a bug in the source code, you can help us by
-[submitting an issue][issues] to our [GitHub Repository][crowi-plus]. 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, please submit an issue with
-a proposal for your work first, to be sure that we can use it.
-Please consider what kind of change it is:
-
-* For a **Major Feature**, first open an issue and outline your proposal so that it can be
-discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
-and help you to craft the change so that it is successfully accepted into the project.
-* **Small Features** can be crafted and directly [submitted as a Pull Request][pulls].
-
-Language
----------
-
-Write issues and PRs in Engulish or Japanese.
-
-Discussion
------------
-
-If you have something to ask or want to discuss, [join to our Slack team][slackin] and talk about anything, anytime.
+(TBD)
 
 License
 =======
@@ -196,8 +168,6 @@ License
 
 [crowi]: https://github.com/crowi/crowi
 [crowi-plus]: https://github.com/weseek/crowi-plus
-[issues]: https://github.com/weseek/crowi-plus/issues
-[pulls]: https://github.com/weseek/crowi-plus/pulls
 [dockerhub]: https://hub.docker.com/r/weseek/crowi-plus
 [docker-compose]: https://github.com/weseek/crowi-plus-docker-compose
 [slackin]: https://crowi-plus-slackin.weseek.co.jp/