pitjazz commented on a change in pull request #77: URL: https://github.com/apache/shiro-site/pull/77#discussion_r578349161
########## File path: how-to-contribute.md ########## @@ -104,74 +99,101 @@ If you want to add a feature, you should bring it up for discussion on the dev@s In short, communication is a vital part of making a contribution to an Apache project. +<a name="HowtoContribute-git"></a> +<a name="HowtoContribute-GitUsage"></a> +##Git Usage + +An overview of how to use Git to participate in Shiro development. Beginners, do't be afraid - you cannot accidentally destroy the actual code repository, because you are working with a local copy as an anonymous user. Therefore, you do not have the system permissions to change anything. You can only update your local repository and compare your revisions with the real repository. The [Download Shiro](download.html "Download") page explains how to check-out the code base and build your local copy. + <a name="HowtoContribute-gettingStartedGit"></a> -###Getting Started +###Git, Getting Started -First, lets make sure that you've added your name and email to your `~/.gitconfig`: +Add your name and email to your `~/.gitconfig`: ``` bash $ git config --global user.name "Your Name" $ git config --global user.email [email protected] ``` -You'll grab the Shiro source with git: +Grab the Shiro source: ``` bash $ git clone https://gitbox.apache.org/repos/asf/shiro.git ``` -If you already have the source, make sure you're working with the most recent version. Do a `git pull` if you cloned the source more than a few hours ago. (Apache Shiro development can move pretty fast!) +Make sure you're working with the most recent version. Do a `git pull` if you cloned the source more than a few hours ago. ``` bash $ git checkout -b mybranch ``` Review comment: Squashed the reverting commit. Added instruction to fork in "getting started" section. ########## File path: how-to-contribute.md ########## @@ -104,74 +99,101 @@ If you want to add a feature, you should bring it up for discussion on the dev@s In short, communication is a vital part of making a contribution to an Apache project. +<a name="HowtoContribute-git"></a> +<a name="HowtoContribute-GitUsage"></a> +##Git Usage + +An overview of how to use Git to participate in Shiro development. Beginners, do't be afraid - you cannot accidentally destroy the actual code repository, because you are working with a local copy as an anonymous user. Therefore, you do not have the system permissions to change anything. You can only update your local repository and compare your revisions with the real repository. The [Download Shiro](download.html "Download") page explains how to check-out the code base and build your local copy. + <a name="HowtoContribute-gettingStartedGit"></a> -###Getting Started +###Git, Getting Started -First, lets make sure that you've added your name and email to your `~/.gitconfig`: +Add your name and email to your `~/.gitconfig`: ``` bash $ git config --global user.name "Your Name" $ git config --global user.email [email protected] ``` -You'll grab the Shiro source with git: +Grab the Shiro source: ``` bash $ git clone https://gitbox.apache.org/repos/asf/shiro.git ``` -If you already have the source, make sure you're working with the most recent version. Do a `git pull` if you cloned the source more than a few hours ago. (Apache Shiro development can move pretty fast!) +Make sure you're working with the most recent version. Do a `git pull` if you cloned the source more than a few hours ago. ``` bash $ git checkout -b mybranch ``` -This does two things: One, it creates the branch mybranch and two, it changes your working branch to mybranch. Running `git branch` will show you which branch you're working on, with an asterisk next to the active branch, like so: +This does two things: +* creates the branch mybranch +* changes your working branch to mybranch. +Running `git branch` will show you which branch you're working on, with an asterisk next to the active branch. ``` bash [user@localhost shiro]$ git branch master * mybranch ``` -Make whatever changes you're going to make, be sure to use git add to stage the changes, and then you're going to commit the changes to your working branch: +Use `git add` to stage the changes. Commit the changes to your working branch: Review comment: Do you mean the capitalization this phrase: "Use `git add` to stage the changes. Commit the changes to your working branch:"? I think it should be correct as it is... ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
