Add 'contributing.md'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -10,15 +10,11 @@ assignees: ''
 **Describe the bug**
 A clear and concise description of what the bug is.
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+**Logs**
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+```
+Input your error logs
+```
 
 **Screenshots**
 If applicable, add screenshots to help explain your problem.

README.md

@@ -1,9 +1,11 @@
 # Gitploy 
 
-![test](https://github.com/gitploy-io/gitploy/actions/workflows/test.yaml/badge.svg) ![build](https://github.com/gitploy-io/gitploy/actions/workflows/publish.yaml/badge.svg)
-
 <p align="center">
   <img src="./docs/images/logo_400.png"><br/>
+  <img src="https://img.shields.io/github/v/release/gitploy-io/gitploy?display_name=release">
+  <img src="https://img.shields.io/github/v/release/gitploy-io/gitploy?include_prereleases&label=pre-release">
+  <img src="https://github.com/gitploy-io/gitploy/actions/workflows/test.yaml/badge.svg">
+  <img src="https://github.com/gitploy-io/gitploy/actions/workflows/publish.yaml/badge.svg"><br/>
   <b>Gitploy helps your team build the deployment system around GitHub in minutes.</b><br/>
   <a href="https://docs.gitploy.io/">Documentation</a> | <a href="https://github.com/gitploy-io/gitploy/discussions">Community</a> | <a href="https://docs.gitploy.io/tasks/installation/">Installation Guide</a>
 </p>
@@ -54,4 +56,6 @@ Documentation | Community | Installation Guide | Docker Image
 
 ## Contributors
 
-TBD
+Don't be afraid to contribute! We have many things you can do to help out. If you're trying to contribute but stuck, please tag @hanjunlee.
+
+You can check the [contributing](./docs/contributing.md) for exact details on how to contribute.

docs/contributing.md

@@ -0,0 +1,73 @@
+# Contributing
+
+Please take a moment to review this document in order to make the contribution process easy and effective
+
+## Support Requests
+
+The [discussions](https://github.com/gitploy-io/gitploy/discussions) page is the preferred channel for support requests. Please do not use the issues for personal support requests.
+
+## Feature Requests
+
+Feature requests are always welcome. It is up to you to make a case to convince the developers of the merits of this feature. Please provide as much detail and context as possible.
+
+## Pull Requests
+
+Please discuss the feature on the issue before working on any significant pull requests. And pull requests should avoid containing unrelated commits.
+
+Please check the checklist to increase the likelihood of your pull request being accepted on time:
+
+* Run the unit tests.
+* Include unit tests when you contribute a new feature.
+* Include unit tests when you contribute a bug fix to prevent regressions.
+
+## Development
+
+### Server
+
+1\. Install prerequsites:
+
+* [golang](https://golang.org/dl/)+1.15
+* [mockgen](https://github.com/golang/mock)@v1.6.0
+
+2\. Set up the `.env` file at the root directory: 
+
+```
+GITPLOY_SERVER_HOST=localhost
+GITPLOY_GITHUB_CLIENT_ID=XXXXXXXXXXXXXXX
+GITPLOY_GITHUB_CLIENT_SECRET=XXXXXXXXXXXXX
+GITPLOY_STORE_SOURCE=file:./sqlite3.db?cache=shared&_fk=1
+```
+
+Note that if you want to interact with GitHub in the local environment, you should install tunneling tools such as [ngork](https://ngrok.com/) and expose your local server.
+
+3\. Run the server:
+
+```
+go run ./cmd/server
+```
+
+### UI
+
+1\. Install prerequisites:
+
+* [node](https://nodejs.org/ko/download/)+14.17.0
+
+2\. Install dependencies
+
+```
+cd ./ui
+npm install
+```
+
+3\. Set up the `.env` file at the `ui` directory:
+
+```
+REACT_APP_GITPLOY_TOKEN=YOUR_TOKEN
+REACT_APP_GITPLOY_SERVER=http://localhost
+```
+
+4\. Run:
+
+```
+npm start
+```

mkdocs.yml

@@ -30,6 +30,7 @@ nav:
   - References: 
     - Configurations: references/configurations.md
     - "deploy.yml": references/deploy.yml.md
+  - Contributing: contributing.md
 extra:
   social:
     - icon: fontawesome/brands/github