-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
wiki: Update contributing instructions.
- Loading branch information
1 parent
74907fb
commit b7bbfaa
Showing
2 changed files
with
14 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,29 @@ | ||
<img src="images/logo_wide_v1.svg" width="250"> | ||
|
||
The dcrdex wiki provides documentation for dcrdex users and developers. | ||
The dcrdex wiki provides documentation for dcrdex users and developers. | ||
|
||
Most likely you want to look at the [README](https://github.com/decred/dcrdex/blob/master/README.md) or the [spec](https://github.com/decred/dcrdex/blob/master/spec/README.mediawiki) instead of these wiki pages. | ||
Also have a look at the [README](https://github.com/decred/dcrdex/blob/master/README.md) and the [spec](https://github.com/decred/dcrdex/blob/master/spec/README.mediawiki). | ||
|
||
## Contribute changes to the wiki | ||
|
||
The following instructions assume that you have already forked **dcrdex**. | ||
|
||
1. Initialize your forked wiki on github by navigating to the wiki tab of your forked **dcrdex** repo and clicking the "Create the first page" button. | ||
1. Initialize your forked wiki on github by navigating to the wiki tab of your forked **dcrdex** repo and clicking the "Create the first page" button. Be sure to "Save page" as well. | ||
|
||
<img src="images/wiki-creation.png" width="700"> | ||
|
||
2. In your terminal, navigate to your local **dcrdex** directory and clone the wiki from the **decred/dcrdex** repo. | ||
2. In your terminal, navigate to your local **dcrdex** directory and add your remote wiki. | ||
|
||
`git clone https://github.com/decred/dcrdex.wiki.git wiki` | ||
``` | ||
git remote add wiki https://github.com/your-username/dcrdex.wiki.git | ||
git push wiki -d master | ||
git subtree push --prefix docs/wiki wiki master | ||
``` | ||
|
||
3. Create a remote for your fork's wiki, replacing 'your-username' with your username. | ||
3. Now after committing changes to the files in the docs/wiki folder, you can apply them to your dcrdex wiki and view immediately. Assuming you are in the root directory: | ||
|
||
`cd wiki; git remote add me https://github.com/your-username/dcrdex.wiki.git` | ||
``` | ||
git push wiki $(git subtree split --prefix docs/wiki):master --force | ||
``` | ||
|
||
4. Create a branch to track the decred/dcrdex wiki. | ||
|
||
`git checkout -b master-upstream origin/master` | ||
|
||
5. Now when you want to do some work, create a new branch based on this one. | ||
|
||
`git checkout master-upstream` | ||
|
||
`git pull` | ||
|
||
`git checkout -b cool-stuff` | ||
|
||
6. Unfortunately, you cannot view any wiki branch but master on github, so you'll want to commit your changes to your fork's master wiki branch and view them in your repo at github before requesting a merge. | ||
|
||
`git push --force me cool-stuff:master` | ||
|
||
7. Also unfortunately, github does not support pull requests for wikis, so contact @chappjc, and tell him you'd like to merge changes from your forked repo wiki. Keep your wiki master branch updated with your changes as you make them so that they can be viewed during review. | ||
4. Make a pull request with your changes to dcrdex. They will make it to the main wiki eventually. |