forked from openwebwork/webwork2
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.md.bak
43 lines (28 loc) · 1.79 KB
/
README.md.bak
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
This is a rough draft of our developer instructions, so parts of it are likely missing or wrong. Any corrections/additions are welcome
We're trying to follow [git flow](http://nvie.com/posts/a-successful-git-branching-model/) so it would be a good idea for developers to read up on it
and [install](https://github.com/nvie/gitflow/wiki/Installation) the commandline tools.
We're working on getting our own, more specific, documentation up about our desired development flow.
Here are the basics to get you set up developing.
First create an account/login to github. Head to the https://github.com/openwebwork/webwork2 and click **fork**.
Once that's done, clone your newly forked repo to your local computer and add openwebwork as an upstream.
```
git remote add upstream git://github.com/openwebwork/webwork2.git
```
I'd also recomend making sure the develop branch is pulled down from openwebwork and ready to push up to your github repo.
```
git checkout -b develop upstream/develop
git branch --set-upstream develop origin/develop
```
This will let you keep your version up to date with the official one.
The rest of these instructions will assume your using the [git flow commandline](https://github.com/nvie/gitflow/wiki/Command-Line-Arguments).. if you're not, there are equivilant commands in pure git.
First get your local repo ready for git flow
```
git flow init
```
Here are the basics for working on a new feature
```
git flow feature start <name>
```
then make your changes, and when ready push everything up to your github for people to see `git push origin`.
When your feature is stable (or close) you can issue a pull requst on github from your feature branch to the openwebwork/webwork2 develop branch.
Including a comment stating what the feature is and any more information would be great.