Repository: shiro Updated Branches: refs/heads/master ab9025951 -> 5b03bf39d
Replace 'ACS' with 'Apache Shiro' in CONTRIBUTING.md Project: http://git-wip-us.apache.org/repos/asf/shiro/repo Commit: http://git-wip-us.apache.org/repos/asf/shiro/commit/5b03bf39 Tree: http://git-wip-us.apache.org/repos/asf/shiro/tree/5b03bf39 Diff: http://git-wip-us.apache.org/repos/asf/shiro/diff/5b03bf39 Branch: refs/heads/master Commit: 5b03bf39dfb8aca1bdde8fed764292f060a67ab0 Parents: ab90259 Author: Andreas Kohn <[email protected]> Authored: Fri Mar 18 18:15:38 2016 +0100 Committer: bdemers <[email protected]> Committed: Wed Mar 23 13:33:09 2016 -0400 ---------------------------------------------------------------------- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/shiro/blob/5b03bf39/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f160e6..3c4052e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ Contributing to Apache Shiro Summary ------- -This document covers how to contribute to the ACS project. These instructions assume you have a GitHub.com account, so if you don't have one you will have to create one. Your proposed code changes will be published to your own fork of the ACS project and you will submit a Pull Request for your changes to be added. +This document covers how to contribute to the Apache Shiro project. These instructions assume you have a GitHub.com account, so if you don't have one you will have to create one. Your proposed code changes will be published to your own fork of the Apache Shiro project and you will submit a Pull Request for your changes to be added. _Lets get started!!!_ @@ -15,7 +15,7 @@ In your browser, navigate to: [https://github.com/apache/shiro](https://github.c Fork the repository by clicking on the 'Fork' button on the top right hand side. The fork will happen and you will be taken to your own fork of the repository. Copy the Git repository URL by clicking on the clipboard next to the URL on the right hand side of the page under '**HTTPS** clone URL'. You will paste this URL when doing the following `git clone` command. -On your computer, follow these steps to setup a local repository for working on ACS: +On your computer, follow these steps to setup a local repository for working on Apache Shiro: ``` bash $ git clone https://github.com/YOUR_ACCOUNT/shiro.git @@ -30,7 +30,7 @@ $ git rebase upstream/master Making changes -------------- -It is important that you create a new branch to make changes on and that you do not change the `master` branch (other than to rebase in changes from `upstream/master`). In this example I will assume you will be making your changes to a branch called `feature_x`. This `feature_x` branch will be created on your local repository and will be pushed to your forked repository on GitHub. Once this branch is on your fork you will create a Pull Request for the changes to be added to the ACS project. +It is important that you create a new branch to make changes on and that you do not change the `master` branch (other than to rebase in changes from `upstream/master`). In this example I will assume you will be making your changes to a branch called `feature_x`. This `feature_x` branch will be created on your local repository and will be pushed to your forked repository on GitHub. Once this branch is on your fork you will create a Pull Request for the changes to be added to the Apache Shiro project. It is best practice to create a new branch each time you want to contribute to the project and only track the changes for that pull request in this branch. @@ -48,7 +48,7 @@ $ git commit -a -m "descriptive commit message for your changes" Rebase `feature_x` to include updates from `upstream/master` ------------------------------------------------------------ -It is important that you maintain an up-to-date `master` branch in your local repository. This is done by rebasing in the code changes from `upstream/master` (the official ACS project repository) into your local repository. You will want to do this before you start working on a feature as well as right before you submit your changes as a pull request. I recommend you do this process periodically while you work to make sure you are working off the most recent project code. +It is important that you maintain an up-to-date `master` branch in your local repository. This is done by rebasing in the code changes from `upstream/master` (the official Apache Shiro project repository) into your local repository. You will want to do this before you start working on a feature as well as right before you submit your changes as a pull request. I recommend you do this process periodically while you work to make sure you are working off the most recent project code. This process will do the following: @@ -104,4 +104,4 @@ You can delete these deprecated branches with the following: $ git checkout master $ git branch -D feature_x $ git push origin :feature_x -``` \ No newline at end of file +```
