WillemJiang closed pull request #20: SCB-142 translate developers pages URL: https://github.com/apache/incubator-servicecomb-website/pull/20
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/_developers/setup-develop-environment.md b/_developers/setup-develop-environment.md index 70ada48..6e3a330 100644 --- a/_developers/setup-develop-environment.md +++ b/_developers/setup-develop-environment.md @@ -1,63 +1,70 @@ --- -title: "??????" +title: "Setup Developing Environment" lang: en ref: setup-develop-environment permalink: /developers/setup-develop-environment/ -excerpt: "??????" +excerpt: "setup developing environment" last_modified_at: 2017-06-24T18:48:43+08:00 --- -## ?????? -????????????????? -* **Git**????????[Git????](https://git-scm.com/book/zh/v2/%E8%B5%B7%E6%AD%A5-%E5%AE%89%E8%A3%85-Git){:target="_blank"} -* **JDK 1.8**????????[JDK????](https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html){:target="_blank"} -* **Maven 3.x**????????[Maven????](https://maven.apache.org/install.html){:target="_blank"} -* **Docker**????????[Docker ????](https://docs.docker.com/engine/installation/){:target="_blank"} -* **Service Center**, ???????[Service Center????](/users/setup-environment/#??service-center) -* **IntelliJ Idea IDE**(?????????????IDE??eclipse)????????[IntelliJ????](https://www.jetbrains.com/help/idea/installing-and-launching.html){:target="_blank"} +## Install required tools +Before you start, make sure you have the following tools installed: +* **Git**?please refer to [Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git){:target="_blank"} +* **JDK 1.8**?please refer to [Install JDK](https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html){:target="_blank"} +* **Maven 3.x**?please refer to [Install Maven](https://maven.apache.org/install.html){:target="_blank"} +* **Docker**?please refer to [Install Docker](https://docs.docker.com/engine/installation/){:target="_blank"} +* **Service Center**, please refer to [Install Service Center](/users/setup-environment/#??service-center) +* **IntelliJ Idea IDE**(optional, you can use any IDE you like, e.g. eclipse), please refer to[Install IntelliJ](https://www.jetbrains.com/help/idea/installing-and-launching.html){:target="_blank"} -## Git?? -1. ??Github???ServiceComb???????Github???????????Github??????? [https://github.com/join?source=header-home](https://github.com/join?source=header-home) ?????????Github?????????????????? [https://github.com/login?return_to=%2Fjoin%3Fsource%3Dheader-home](https://github.com/login?return_to=%2Fjoin%3Fsource%3Dheader-home) ??????? -2. ??Git?????Git???????????????????????????????? +## Setup git +1. Get a Github account. The ServiceComb projects is hosted on Github, so you will need a Github account. You can goto [https://github.com/join?source=header-home](https://github.com/join?source=header-home) for signup. Skip this if you already own an Github account. You can login on [https://github.com/login?return_to=%2Fjoin%3Fsource%3Dheader-home](https://github.com/login?return_to=%2Fjoin%3Fsource%3Dheader-home) after you finished the signup. + +2. Configure Git. Configure personal information and setup git for push without username/password. + Configure personal information: ```bash git config --global user.name <your-user-name> git config --global user.email <your-email-address> ``` - ?????\<your-user-name\>?\<your-email-address\>?????Github???????????????????????????[Git?????????](https://stackoverflow.com/a/8588786){:target="_blank"}? -3. ???????? [ServiceComb-Java-Chassis](https://github.com/apache/incubator-servicecomb-java-chassis.git) ??????????????????? + Substitute \<your-user-name\>?\<your-email-address\> with your name and email. Refer[Git push without username and password](https://stackoverflow.com/a/8588786){:target="_blank"}to setup pushing without username/password. + +3. Get the source code. For example, to get [ServiceComb-Java-Chassis](https://github.com/apache/incubator-servicecomb-java-chassis.git), execute the following command: ```bash git clone https://github.com/apache/incubator-servicecomb-java-chassis.git ``` - -## IDE ???? -????Java???IDE????Eclipse, IntelliJ IDEA?STS??????????IntelliJ IDEA?????????????????????????IntelliJ IDEA???????[???????](https://www.jetbrains.com/help/idea/installing-and-launching.html#d325787e291)?IntelliJ IDEA????????????[?????](https://www.jetbrains.com/help/idea/keyboard-shortcuts-you-cannot-miss.html)????????? + +## Configure IDE +There are many Java IDEs around, like Eclipse, IntelliJ IDEA and STS, etc. We suggest to use IntelliJ IDEA, it's community edition is good enough for daily usage. After you installed IntelliJ IDEA, follow [Initial Setup](https://www.jetbrains.com/help/idea/installing-and-launching.html#d325787e291) for basic configuration. For frequently used shortcuts, [Cannot Miss Shortcuts](https://www.jetbrains.com/help/idea/keyboard-shortcuts-you-cannot-miss.html) -Java Chassis?Saga?????[Google Code Style](https://github.com/google/styleguide)????????????????? `etc` ??????????????Eclipse????????????????? +The Java Chassis and Saga project uses [Google Code Style](https://github.com/google/styleguide). You can find the settings file under `etc` directory which can be imported to IDEA. There is also a settings file for Eclipse under the same directory. {: .align-center} {% include toc %} -### IntelliJ IDEA ?? -[IntelliJ IDEA](https://www.jetbrains.com/idea/download/)??????? +### IntelliJ IDEA Configuration +Configure [IntelliJ IDEA](https://www.jetbrains.com/idea/download/) -1. ??IntelliJ?? +1. Open IntelliJ Settings page {: .align-center} -1. Import ???? `etc/intellij-java-google-style.xml` +2. Import the coding style settings file `etc/intellij-java-google-style.xml` {: .align-center} -1. ???????????????????????? + +3. Open a modified but uncommited file, then Choose [Code] > [Show Reformat File Dialog] {: .align-center} -1. ?????????? +4. Choose [Only VCS changed text], then click [Run] {: .align-center} -???????????? (Ctrl+Alt+i) ??????????????IntelliJ????????[IntelliJ??](https://www.jetbrains.com/help/idea/tutorials.html)? -## ??? +Just run [Reformat code] (Ctrl+Alt+L) afterwards to format the code. + +For more IntelliJ usages, please check [IntelliJ tutorial](https://www.jetbrains.com/help/idea/tutorials.html)? + +## Next -* ??[??????](/developers/submit-codes/) +* Read[Howto submit codes](/developers/submit-codes/) diff --git a/_developers/submit-codes.md b/_developers/submit-codes.md index 77b5b9d..ec1a5bd 100644 --- a/_developers/submit-codes.md +++ b/_developers/submit-codes.md @@ -1,55 +1,52 @@ --- -title: "??????" +title: "Howto Submit Code" lang: en ref: submit-codes permalink: /developers/submit-codes/ -excerpt: "????? ServiceComb ??????" +excerpt: "Howto submit code for SerivceComb" last_modified_at: 2017-09-08T20:26:43-20:46 --- {% include toc %} -## ???? -??ServiceComb????????????????????????????????ServiceComb ????????? -* ????????????????????????API????????????????????????**???????**?**?Github?????**?????????? -* ???????????BUG????????????????????BUG???????issue?????[Saga](https://github.com/apache/incubator-servicecomb-saga/issues)????????????? **enhancement** ??? **bug** ??????????????BUG??????????????????????????????????????BUG??Issue???????????BUG??PR?????????????????????????????PR? +## Contributing + ServiceComb is still growing and we hope that more will join us to share this. There are many ways to contribute: +* Improve documents. Help us improve the documents on this site or the API documentation. For the documents on this site, you can find links **Report a Doc Issue** or **Edit This Page on Github** to start. +* Implement feature request or fix bugs. You can find all the feature request and bug reports on the projects' issues pages. Take [Saga](https://github.com/apache/incubator-servicecomb-saga/issues) as an example, issues will be labeled as **enhancement** or **bug**, you can choose the ones you are interested in. Bug reports and new feature requests are also welcomed. - {: .align-center} + {: .align-center} -## ???? -????????????????README?????????????????????????????? +## Run tests + Before submitting code, make sure that you have properly tested the functionality and verified the implementation according to the auto test section in README. -## PR?? -??? [Github](https://github.com/search?q=org%3Aapache+servicecomb) ?????????? [Pull Request (PR)](https://help.github.com/articles/about-pull-requests/)??????????[apache/incubator-servicecomb-website](https://github.com/apache/incubator-servicecomb-website) ?????????????????incubator-servicecomb-website?? +## How to submit a PR +??It's quite convenient to submit a [Pull Request(PR)](https://help.github.com/articles/about-pull-requests/) on [Github](https://github.com/search?q=org%3Aapache+servicecomb). Take the [apache/incubator-servicecomb-website](https://github.com/apache/incubator-servicecomb-website) as an example: -### Fork?? +### Fork repository -???? apache/incubator-servicecomb-website ? [github ??](https://github.com/apache/incubator-servicecomb-website) ???????? `Fork` ?? Fork? +??Visit the apache/incubator-servicecomb-website project's [github page](https://github.com/apache/incubator-servicecomb-website), click `Fork` button on the right left cornor. -{: .align-center} +{: .align-center} -### ??git????? +### Setup local repository -- ????????? +- Clone the source code to local machine: ```shell git clone https://github.com/<your_github_name>/incubator-servicecomb-website.git ``` - ????? \<your\_github\_name\> ?????github??? + Note: substitute \<your\_github\_name\> with your github username. + After the clone is done, the origin remote will point to the default branch of the cloned repository. -??clone????origin?????github????fork??? - -- ? apache/incubator-servicecomb-website ???????????? upstream? +- Add apache/incubator-servicecomb-website as upstream remote: ```shell cd incubator-servicecomb-website git remote add upstream https://github.com/apache/incubator-servicecomb-website.git ``` - - -- ????????? +- Check the local repository's remotes ```shell git remote -v @@ -59,65 +56,64 @@ last_modified_at: 2017-09-08T20:26:43-20:46 upstream https://github.com/apache/incubator-servicecomb-website.git (push) ``` - -- ?????????????? +- Create a new branch to start working ```shell git checkout -b <your_branch_name> ``` + + Note: replace \<your\_branch\_name\> with an actual branch name at your choice, like feature-foo/bugfix-bar + Now you can start coding. - -????? \<your\_branch\_name\> ??????????? - -??????????????? - -- ?????????? +- Push the changes to a remote repository ```shell git commit -a -m "<you_commit_message>" git push origin <your_branch_name> ``` -???? git ????????[git ??](https://www.atlassian.com/git/tutorials/setting-up-a-repository)??????? +?For more on git usages, please visit[Git tutorial](https://www.atlassian.com/git/tutorials/setting-up-a-repository). -### ??PR +### Create PR + Goto your github page, find the apache/incubator-servicecomb-website project, swich to the branch you just pushed, click on `New pull request` and then `Create pull request`, see the image below: -???????????? github ????????????? \<your\_branch\_name\> ????? `New pull request` ? `Create pull request` ????????????? - -{: .align-center} +{: .align-center} fig-1 New pull request {: .figure-caption} -{: .align-center} +{: .align-center} fig-2 Create pull request {: .figure-caption} -???????PR????????? PR ??? [collaborating-with-issues-and-pull-requests](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) ? + Congrautulations, now you have succesfully submitted a PR. For more on PR, please read [collaborating-with-issues-and-pull-requests](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) ? + +### Resolve conflicts + When a same piece of file is edited by multiple person simultaneously, conflicts can occur. It can be resolved as follow: -### ???? -????PR??????????????????????????????????????? -1. ?????? +1. Switch to the master branch ```bash git checkout master ``` -2. ?????????? +2. Pull the upstream's master branch ```bash git pull upstream master ``` -3. ???????????????fix? +3. Switch back to the branch we are working on(e.g. fix) ```bash git checkout fix ``` -4. ??rebase +4. Rebase the working branch onto the master branch ```bash git rebase -i master ``` - ???????????????????????????????????????????????????????????????????????????? + A list of commits will be listed on your text editor. Normally we can just save and exit. + Git will now apply the commits one by one onto the master branch until it encounters a conflict. When this happens, the rebase process is paused. We need to resolve the conflicts, then execute ```bash git add . git rebase --continue ``` - ????????????? *rebase successful* ???????????????PR???????? + Repeat this process until all commits are successfully applied. And finally run ```bash git push -f origin fix ``` + to push the resolved branch to remote origin ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
