luke
/
OpenRAM
mirror of https://github.com/VLSIDA/OpenRAM.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dev' of github.com:mguthaus/OpenRAM into dev

This commit is contained in:
Matt Guthaus 2017-11-15 07:45:38 -08:00
parent f123a3ca40 a7a9abbde6
commit 88678d9fa4
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -23,16 +23,19 @@ the tests on your contributions before they will be accepted.
# Pull Request Process # Pull Request Process
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/mguthaus/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>/OpenRAM.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):
``` ```
@ -49,6 +52,7 @@ the tests on your contributions before they will be accepted.
``` ```
if you previously added the one with the git@github that required if you previously added the one with the git@github that required
authentication. authentication.
5. Make your own branch. The number one rule is to put each piece of 5. Make your own branch. The number one rule is to put each piece of
work on its own branch: work on its own branch:
``` ```
@ -63,6 +67,7 @@ the tests on your contributions before they will be accepted.
code (in your fork of the repository). You can check out the released code (in your fork of the repository). You can check out the released
code with "git checkout master" or go back to your ranch with code with "git checkout master" or go back to your ranch with
"gitcheckout useful-branch-name". "gitcheckout useful-branch-name".
6. Edit your code and make commits like normal: 6. Edit your code and make commits like normal:
``` ```
git add <new files> git add <new files>
@ -76,6 +81,7 @@ the tests on your contributions before they will be accepted.
git commit -a -m "Useful comment" git commit -a -m "Useful comment"
``` ```
Run the unit tests entirely. Fix all bugs. Run the unit tests entirely. Fix all bugs.
7. After you are done (or while you are editing and you see changes in 7. After you are done (or while you are editing and you see changes in
MY master branch) make sure you have the most recent from MY master MY master branch) make sure you have the most recent from MY master
and merge any changes. Pull the updated copy from MY master branch in and merge any changes. Pull the updated copy from MY master branch in
@ -92,6 +98,7 @@ the tests on your contributions before they will be accepted.
git push origin master git push origin master
``` ```
if you are on your master branch. Otherwise, just git push. if you are on your master branch. Otherwise, just git push.
8. Push your branch to YOUR repository: 8. Push your branch to YOUR repository:
``` ```
git push -u origin useful-branch-name git push -u origin useful-branch-name
@ -100,13 +107,16 @@ the tests on your contributions before they will be accepted.
branch that you made to contain all your changes. branch that you made to contain all your changes.
The -u flag links this branch with the remote one, so that in the The -u flag links this branch with the remote one, so that in the
future, you can simply type git push origin. future, you can simply type git push origin.
9. When you are done, go to GitHub and you will see a button to notify 9. When you are done, go to GitHub and you will see a button to notify
me. Press the button and it will notify me of your pushed branch. me. Press the button and it will notify me of your pushed branch.
This will have you fill in a form for the contribution that gets sent This will have you fill in a form for the contribution that gets sent
to me. to me.
10. I will review the request and may have you fix stuff if the tests 10. I will review the request and may have you fix stuff if the tests
don't pass, you didn't merge all my changes in master from other don't pass, you didn't merge all my changes in master from other
contributions, or your style of code is bad. contributions, or your style of code is bad.
11. Go back to step 3 for your next contribution. Remember, you can 11. Go back to step 3 for your next contribution. Remember, you can
push/pull work to your repository all the time and can pull from my push/pull work to your repository all the time and can pull from my
master as well. Make sure to add large features so that You don't have master as well. Make sure to add large features so that You don't have