Update references to GitHub repositories
This commit is contained in:
@@ -1,10 +1,10 @@
|
||||
# Communication
|
||||
|
||||
The preferred way to report any missing piece of information is [opening an issue in the project's Github repo](https://github.com/consul/docs/issues/new).
|
||||
The preferred way to report any missing piece of information is [opening an issue in the project's Github repo](https://github.com/consuldemocracy/docs/issues/new).
|
||||
|
||||
For more informal communication, chat with us at [Consul Democracy's gitter](https://gitter.im/consul/consul).
|
||||
|
||||
Before doing it, **please take some time to check the [existing issues](https://github.com/consul/consul/issues) and make sure what you are about to report isn't already reported** by another person. In case someone else reported the same problem before or a similar one, and you have more details about it, you can write a comment in the issue page... a little more help can make a huge difference!
|
||||
Before doing it, **please take some time to check the [existing issues](https://github.com/consuldemocracy/consuldemocracy/issues) and make sure what you are about to report isn't already reported** by another person. In case someone else reported the same problem before or a similar one, and you have more details about it, you can write a comment in the issue page... a little more help can make a huge difference!
|
||||
|
||||
In order to write a new issue, take into account these few tips to make it easy to read and comprehend:
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ Consul Democracy git repo is hosted at Github.com, we recommend using it for you
|
||||
|
||||
2. [Create an Organization](https://help.github.com/articles/creating-a-new-organization-from-scratch/) on Github with the name of your city or the organization that's going to use Consul Democracy. **This is not mandatory**, but it will help understand the fork's purpose and future contributions by other users.
|
||||
|
||||
3. [Fork Consul Democracy](https://help.github.com/articles/fork-a-repo/) using the **fork** button on the top right corner at <https://github.com/consul/consul>
|
||||
3. [Fork Consul Democracy](https://help.github.com/articles/fork-a-repo/) using the **fork** button on the top right corner at <https://github.com/consuldemocracy/consuldemocracy>
|
||||
|
||||
4. [Clone your fork repository](https://help.github.com/articles/cloning-a-repository/) on to your computer.
|
||||
|
||||
@@ -19,4 +19,4 @@ We strongly recommend making code public for multiple reasons:
|
||||
- **Transparency**: It should be part of the culture of public entities that adopt Consul Democracy, as well as any organization or group.
|
||||
- **Support**: If you need technical help, both community and Consul Democracy core team will be able to understand and advice by easily seeing involved code.
|
||||
- **Collaboration**: By other professionals, citizens, etc...
|
||||
- Last but not least, Consul Democracy is distributed under the **[AGPLv3](https://github.com/consul/consul/blob/master/LICENSE-AGPLv3.txt) license** that commands to publish source code.
|
||||
- Last but not least, Consul Democracy is distributed under the **[AGPLv3](https://github.com/consuldemocracy/consuldemocracy/blob/master/LICENSE-AGPLv3.txt) license** that commands to publish source code.
|
||||
|
||||
@@ -10,13 +10,13 @@ git remote -v
|
||||
|
||||
it should output something alike:
|
||||
|
||||
> origin git@github.com:your_user_name/consul.git (fetch)\
|
||||
> origin git@github.com:your_user_name/consul.git (push)
|
||||
> origin git@github.com:your_user_name/consuldemocracy.git (fetch)\
|
||||
> origin git@github.com:your_user_name/consuldemocracy.git (push)
|
||||
|
||||
Now we have to add Consul Democracy's github as upstream remote with:
|
||||
|
||||
```bash
|
||||
git remote add upstream git@github.com:consul/consul.git
|
||||
git remote add upstream git@github.com:consuldemocracy/consuldemocracy.git
|
||||
```
|
||||
|
||||
and to check everything is fine with
|
||||
@@ -27,10 +27,10 @@ git remote -v
|
||||
|
||||
again you should get:
|
||||
|
||||
> upstream git@github.com:consul/consul.git (fetch)\
|
||||
> upstream git@github.com:consul/consul.git (push)\
|
||||
> origin git@github.com:your_user_name/consul.git (fetch)\
|
||||
> origin git@github.com:your_user_name/consul.git (push)
|
||||
> upstream git@github.com:consuldemocracy/consuldemocracy.git (fetch)\
|
||||
> upstream git@github.com:consuldemocracy/consuldemocracy.git (push)\
|
||||
> origin git@github.com:your_user_name/consuldemocracy.git (fetch)\
|
||||
> origin git@github.com:your_user_name/consuldemocracy.git (push)
|
||||
|
||||
## Pulling changes from Consul Democracy
|
||||
|
||||
@@ -52,7 +52,7 @@ And then you can choose to either:
|
||||
|
||||
A. Get all the latest changes on Consul Democracy's **master** branch with `git merge upstream/master`.
|
||||
|
||||
B. Just update up to an specific release tag (so you can do incremental updates if you're more than one release behind). For example to update up to [v0.9](https://github.com/consul/consul/releases/tag/v0.9) release just: `git merge v0.9`.
|
||||
B. Just update up to an specific release tag (so you can do incremental updates if you're more than one release behind). For example to update up to [v0.9](https://github.com/consuldemocracy/consuldemocracy/releases/tag/v0.9) release just: `git merge v0.9`.
|
||||
|
||||
## Merging changes
|
||||
|
||||
@@ -66,4 +66,4 @@ C. You get some git errors along with a `Automatic merge failed; fix conflicts a
|
||||
|
||||
Now you can just simply push your **upstream** branch to github and create a Pull Request so you can easily check all changes going into your repo, and see your tests suite runs.
|
||||
|
||||
Remember you can always quickly check changes that will come from Consul Democracy to your fork by replacing **your_org_name** on the url: <https://github.com/your_org_name/consul/compare/master...consul:master>.
|
||||
Remember you can always quickly check changes that will come from Consul Democracy to your fork by replacing **your_org_name** on the url: <https://github.com/your_org_name/consuldemocracy/compare/master...consuldemocracy:master>.
|
||||
|
||||
Reference in New Issue
Block a user