From 3e78ec38f71719c4860e13dd6b4b68dab79b506d Mon Sep 17 00:00:00 2001 From: zhongjun2 Date: Sun, 28 Jun 2020 20:14:23 +0800 Subject: [PATCH] Add contribute --- .gitee/ISSUE_TEMPLATE.en.md | 10 ++- .gitee/PULL_REQUEST_TEMPLATE.en.md | 7 -- CONTRIBUTING.md | 101 ++--------------------------- 3 files changed, 14 insertions(+), 104 deletions(-) diff --git a/.gitee/ISSUE_TEMPLATE.en.md b/.gitee/ISSUE_TEMPLATE.en.md index b8399dbe7..458911819 100644 --- a/.gitee/ISSUE_TEMPLATE.en.md +++ b/.gitee/ISSUE_TEMPLATE.en.md @@ -2,9 +2,9 @@ > Uncomment only one, leave it on its own line: > -> /kind bug +> - bug > -> /kind feature +> - feature **What happened**: @@ -15,3 +15,9 @@ **Anything else we need to know?**: +**Environment**: +- Version: +- OS (e.g. from /etc/os-release): +- Kernel (e.g. `uname -a`): +- Install tools: +- Others: diff --git a/.gitee/PULL_REQUEST_TEMPLATE.en.md b/.gitee/PULL_REQUEST_TEMPLATE.en.md index b7cec5363..fb9f65379 100644 --- a/.gitee/PULL_REQUEST_TEMPLATE.en.md +++ b/.gitee/PULL_REQUEST_TEMPLATE.en.md @@ -1,11 +1,4 @@ -** What type of PR is this? **: - -> Uncomment only one, leave it on its own line: -> -> /kind bug -> -> /kind feature **What this PR does / why we need it**: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e7a3d74c9..47640c058 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,90 +1,8 @@ # How to contribute -### Brief Introduction - -Before you start, NOTICE that ```master``` branch is development version. ```stable``` branch -provided for customers and users. So all code modifications SHOULD be submitted to -```master``` branch, ```stable``` branch won't accept any commits. - -This repository is integrated by website which will provide the final outline, so please only maintain docs in this repository. -anything others like styles, js are maintained in website as a combined hugo theme. - -Contents oranganized by hugo book which is a framework helping build our own book. -please refer to hugo book [website](https://github.com/alex-shpak/hugo-book) for more detailed information. - -All files are written with MarkDown syntax, please note: If you want to add internal links, -be careful to point to the .html pages corresponding to the .md pages of the folder. - -### Debug local - -This doc only provides running test on linux, please prepare linux server before running -following commands. - -1. Install hugo on server - -hugo can be installed easily after nodejs is ready. - -``` -curl -L https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_0.56.3_Linux-64bit.tar.gz | tar -xz && \ - mv hugo /usr/local/bin/ -``` - -2. Running this repository locally - -``` -hugo serve --bind 0.0.0.0 --port 80 --baseUrl / -``` - -The website will serving on http://your-server-ip:80 - - -### Debug with docker - -1. Build Image - -``` -docker build -t docs:v0.0.1 . -``` - -note: here ```docs``` is the image name, you can change it as you need. - -2. Running in container - -``` -docker run -p 80:80 -d docs:v0.0.1 > docs.pid -``` - -The website will serving on http://your-server-ip:80 - -3. Stopping the container - -``` -docker rm -f `cat docs.pid` && rm -f docs.pid -``` - -***Note***: -The defalut language(en) will serving on http://your-server-ip/ -Other language(zh) will serving on http://your-server-ip/zh - -### Add/Modify file - -Before openning a PR, running locally and have a check would be good step that will help -your commits be merged quickly. - -There are two kinds of Markdown file, one is the content files which locates in ```content/docs``` folder. -the other one is the menu file which locates in ```content/menu``` folder. please remember to update menu if -adding new file. - -Note: menu file home file name must be named ```home.md```. - -## Getting help - -- IRC: TODO -- Mail: TODO - ## Report issues -A great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report and feature propose, and will thank you for it! +A great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report and feature propose, and will appreciate you for it! ### Issues format @@ -98,12 +16,11 @@ When reporting issues, refer to this format: - Anything else we need to know? - Environment -See more about [ISSUE_TEMPLATE](.github/ISSUE_TEMPLATE.md). +See more about [ISSUE_TEMPLATE](.gitee/ISSUE_TEMPLATE.en.md). ## Submit pull requests -If you are a beginner and expect this project as the gate to open source world, this tutorial is one of the best -choices for you. Just follow the guidance and you will find the pleasure to becoming a contributor. +If you are a beginner and expect this project as the gate to open source world, this tutorial is one of the best choices for you. Just follow the guidance and you will find the pleasure to become a contributor. ### Step 1: Fork repository @@ -115,7 +32,7 @@ to avoid the inconsistency between these two repos. If you want to download the code to the local machine, ```git``` is the best way: ``` -git clone https://your_repo_url/projectname.git +git clone https://your_repo_url/community.git ``` ### Step 3: Develop code locally @@ -132,7 +49,7 @@ After updating the code, you should push the update in the formal way: ``` git add . git status (Check the update status) -git commit -m "Your commit title" +git commit -m "Your commit description" git commit --amend (Add the concrete description of your commit) git push origin new_branch_name ``` @@ -151,15 +68,9 @@ When submitting pull requests, refer to this format: - Special notes for your reviewer - Release note -See more about [PULL_REQUEST_TEMPLATE](.github/PULL_REQUEST_TEMPLATE.md). +See more about [PULL_REQUEST_TEMPLATE](.gitee/PULL_REQUEST_TEMPLATE.en.md). ### Code style ```TO BE DEFINED``` - - - - - - -- Gitee