Skip to content
This repository has been archived by the owner on Jul 6, 2020. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
-Change schema to better reflect how PieCentral was made to do. 
-Change branch naming scheme to project_name/feature_name or project_name/name/feature_name to better organize the branches and find specific branches
-Staff will edit their specific branches or feature branches.
-Rebase onto master to create a linear commit history. To push to master staff must rebase onto master locally, then open a pull request. 
-All code will be code reviewed
  • Loading branch information
brandonxxlee committed Sep 18, 2016
1 parent 5d8ae3a commit ed7d26e
Showing 1 changed file with 33 additions and 7 deletions.
40 changes: 33 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,41 @@

### If you want to learn more about these repositories, check out their directories!

### A note to contributers:

- You don't have to fork! Instead, make your own branch in the central repo.
## Contributing to PieCentral
### Setting up PieCentral

```
$ cd {directory of your choice}
$ git clone https://github.com/pioneers/PieCentral.git
$ cd PieCentral
```

### Creating a Branch
Naming convention: project_name/feature_name

Feel free to name "feature_name" anything and/or use more slashes.

e.g. dawn/UDPintegration, atalanta/andy/UDPintegration
```
$ git branch {project_name/feature_name}
$ git checkout {project_name/feature_name}
$ git push origin {project_name/feature_name}
```

### Adding new code to master
All code is rebased onto master, meaning new commits are added directly onto master, creating a linear commit history.

Merge conflicts may arise when rebasing, make sure to fix conflicts before continuing.

- Also, when you are making your branch, make sure to follow this naming convention:

**your_name/feature_name**
```
$ git fetch origin master
$ git rebase master
$ git push {project_name/feature_name}
```
Open a pull request to master.

Code will be code reviewed by PMs.

- feel free to split the project further with more slashes
Code will be rebased onto master. (Choose "Squash and Merge" instead of "Create a merge commit")

[logo]: https://upload.wikimedia.org/wikipedia/en/e/e4/Pioneers_in_Engineering_Logo_1.png "Logo"

0 comments on commit ed7d26e

Please sign in to comment.