consul/nairobi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update application name

Browse Source 
Note that, in order to have some consistency, we're always writing
"Consul Democracy", instead of using capital letters sometimes (but not
always), like we did until now.
This commit is contained in:
Javi Martín
2023-07-10 19:51:02 +02:00
parent 68d0ffe5ec
commit 13c641eedc
52 changed files with 240 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/en/open_source/contributing.md
View File

@@ -1,10 +1,10 @@
# Contributing
We appreciate you want to help us by contributing to Consul. Here's a guide we made describing how to contribute changes to the project.
We appreciate you want to help us by contributing to Consul Democracy. Here's a guide we made describing how to contribute changes to the project.
## Reporting an issue
If you have seen anything wrong in the platform performance or directly in the code, we encourage you to [open an issue in the Consul Github repository](https://github.com/consul/consul/issues/new).
If you have seen anything wrong in the platform performance or directly in the code, we encourage you to [open an issue in the Consul Democracy Github repository](https://github.com/consul/consul/issues/new).
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, if you have more details about it you can write a comment in the issue page -a little more help can make a huge difference!
@@ -16,7 +16,7 @@ In order to write a new issue, take into account these few tips to make it easy
## Resolving an issue
[Issues in Consul](https://github.com/consul/consul/issues) labeled with `PRs-welcome` are well defined features ready to be implemented by whoever wants to do it. In the other hand, the `not-ready` label marks features or changes not well defined yet or subject to an internal decision, so we recommend not to try to resolve them until the admins come to a resolution.
[Issues in Consul Democracy](https://github.com/consul/consul/issues) labeled with `PRs-welcome` are well defined features ready to be implemented by whoever wants to do it. In the other hand, the `not-ready` label marks features or changes not well defined yet or subject to an internal decision, so we recommend not to try to resolve them until the admins come to a resolution.
We suggest to follow these steps to keep a good track of the changes you're about to make:
@@ -25,15 +25,15 @@ We suggest to follow these steps to keep a good track of the changes you're abou
- Create a feature branch based on the `master` branch. To make it easier to identify, you can name it with the issue number followed by a concise and descriptive name (e.g. `123-fix_proposals_link`).
- Work in your branch committing there your changes.
- Make sure all tests are passing. In case you're extending or creating a new feature, consider adding its own specs.
- Once you've finished, send a **pull request** to the [Consul repository](https://github.com/consul/consul/) describing your solution to help us understand it. It's also important to tell what issue you're addressing, so specify it in the pull request description's first line (e.g. `Fixes #123`).
- Once you've finished, send a **pull request** to the [Consul Democracy repository](https://github.com/consul/consul/) describing your solution to help us understand it. It's also important to tell what issue you're addressing, so specify it in the pull request description's first line (e.g. `Fixes #123`).
- Our core team will review your PR and suggest changes if necessary. If everything looks good, your changes will be merged :)
> **Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
## Other ways of contributing
We'll appreciate any kind of contribution to Consul. Even if you can't contribute to it coding, you still can:
We'll appreciate any kind of contribution to Consul Democracy. Even if you can't contribute to it coding, you still can:
- Create issues about any problem or error you've encountered.
- Help translate the platform to other languages you master at [Consul's Crowdin](https://crwd.in/consul).
- Help with [Consul's documentation](https://github.com/consul/docs).
- Help translate the platform to other languages you master at [Consul Democracy's Crowdin](https://crwd.in/consul).
- Help with [Consul Democracy's documentation](https://github.com/consul/docs).