Small updates to CONTRIBUTING.md

This commit is contained in:
Matt Guthaus 2018-11-05 13:14:16 -08:00
parent ce94366a1d
commit cf4c138032
1 changed files with 5 additions and 5 deletions

View File

@ -20,7 +20,7 @@ other OpenRAM features. Please see the README.md file on how to run
the unit tests. Unit tests should work in all technologies. We will run the unit tests. Unit tests should work in all technologies. We will run
the tests on your contributions before they will be accepted. the tests on your contributions before they will be accepted.
# Internally Development # Internal Development
For internal development, follow all of the following steps EXCEPT For internal development, follow all of the following steps EXCEPT
do not fork your own copy. Instead, create a branch in our private repository do not fork your own copy. Instead, create a branch in our private repository
@ -32,21 +32,21 @@ All unit tests should pass first.
1. One time, create a GitHub account at http://github.com 1. One time, create a GitHub account at http://github.com
2. Create a fork of the OpenRAM project on the github web page: 2. Create a fork of the OpenRAM project on the github web page:
https://github.com/mguthaus/OpenRAM https://github.com/vlsida/openram
It is on the upper right and says "Fork": This will make your own It is on the upper right and says "Fork": This will make your own
OpenRAM repository on GitHub in your account. OpenRAM repository on GitHub in your account.
3. Clone your repository (or use an existing cloned copy if you've 3. Clone your repository (or use an existing cloned copy if you've
already done this once): already done this once):
``` ```
git clone https://github.com/<youruser>/OpenRAM.git git clone https://github.com/<youruser>/oepnram.git
cd OpenRAM cd openram
``` ```
4. Set up a new upstream that points to MY OpenRAM repository that you 4. Set up a new upstream that points to MY OpenRAM repository that you
forked (only first time): forked (only first time):
``` ```
git remote add upstream https://github.com/mguthaus/OpenRAM.git git remote add upstream https://github.com/vlsida/openram.git
``` ```
You now have two remotes for this project: You now have two remotes for this project:
* origin which points to your GitHub fork of the project. You can read * origin which points to your GitHub fork of the project. You can read