Update CONTRIBUTING.md

This commit is contained in:
Andy Alt
2018-03-01 10:51:56 -06:00
committed by GitHub
parent a0c05c79ab
commit 3ab2130648

View File

@@ -31,10 +31,17 @@ ZetaGlest Issues are filed on these repositories:
* [zetaglest-source Issues](https://github.com/ZetaGlest/zetaglest-source/issues)
* [zetaglest-data Issues](https://github.com/ZetaGlest/zetaglest-data/issues)
* [zetaglest-masterserver Issues](https://github.com/ZetaGlest/zetaglest-masterserver/issues)
* [ZetaGlest web site](https://github.com/ZetaGlest/zetaglest.github.io)
This link will display a combined list of issues across every
repository in the ZetaGlest organization (hint: a good link to
bookmark).
Don't worry about focusing on every repo in the above list. Each repo is separated by
category. For example, zetaglest-source is for source code, zetaglest-data is for game data.
We don't expect contributors to keep track of issues in every repository. If you stay
with the project for a while, you will not have any problem finding your way around.
For new users, it's recommended to focus on only one repository. However,
if you are curious to get an overview of every issue filed from the repo list above, this
link will display a combined list of issues across every repository in the ZetaGlest
organization.
[https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3AZetaGlest](https://github.com/issues?q=is%3Aopen+is%3Aissue+org%3AZetaGlest)
@@ -71,6 +78,17 @@ easily contribute patches, graphics, or other content to the ZetaGlest
repositories.
## Pull Requests
Follow the steps below if you are contributing to any of these repositories:
* [data](https://github.com/ZetaGlest/zetaglest-data)
* [masterserver](https://github.com/MegaGlest/megaglest-masterserver)
* [website](https://github.com/ZetaGlest/zetaglest.github.io)
Below, *zetaglest-source* for the example, but if you are working on another repository, be
sure to replace **zetaglest-source** with the the appropriate repo url, using the URL of
your fork.
1. [Fork the repo](https://github.com/ZetaGlest/zetaglest-source/fork) (if you haven't already done so)
2. Clone it to your computer
3. When you're ready to work on an issue, be sure you're on the **develop** branch. From there,
@@ -103,8 +121,3 @@ repo with the remote upstream. GitHub has instructions for doing this:
* For step 3 on that page, use https://github.com/ZetaGlest/zetaglest-source for the URL.
2. [Syncing a Fork](https://help.github.com/articles/syncing-a-fork/)
* On that page, it shows how to merge the **develop** branch (steps 4 & 5 of **Syncing a Fork**).
Follow these steps if you are contributing to the
[data](https://github.com/ZetaGlest/zetaglest-data) or
[masterserver](https://github.com/MegaGlest/megaglest-masterserver)
repository.