Skip to content
This repository was archived by the owner on Jun 22, 2021. It is now read-only.

Commit 27a6e5e

Browse files
author
Johnny Goodnow
authored
Update CONTRIBUTING. (#491)
1 parent 885a652 commit 27a6e5e

File tree

1 file changed

+33
-18
lines changed

1 file changed

+33
-18
lines changed

CONTRIBUTING.md

+33-18
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# How to contribute to a Stellar project
22

3-
Your contributions to the [Stellar network](https://www.stellar.org/) will help improve the world’s financial
4-
infrastructure, faster.
3+
Your contributions to the [Stellar network](https://www.stellar.org/) will help improve the world’s
4+
financial infrastructure, faster.
55

6-
We want to make it as easy as possible to contribute changes that
7-
help the Stellar network grow and thrive. There are a few guidelines that we
8-
ask contributors to follow so that we can merge your changes quickly.
6+
We want to make it as easy as possible to contribute changes that help the Stellar network grow and
7+
thrive. There are a few guidelines that we ask contributors to follow so that we can merge your
8+
changes quickly.
99

1010
## Getting Started
1111

@@ -25,12 +25,17 @@ an issue number.
2525

2626
## Finding things to work on
2727

28-
The first place to start is always looking over the current GitHub issues for the project you are interested in contributing to. Issues marked with [help wanted](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Astellar+label%3A%22help+wanted%22) are usually pretty self-contained and a good place to get started.
28+
The first place to start is always looking over the current GitHub issues for the project you are
29+
interested in contributing to. Issues marked with [help wanted][help-wanted] are usually pretty
30+
self-contained and a good place to get started.
2931

30-
Stellar.org also uses these same GitHub issues to keep track of what we are working on. If you see any issues that are assigned to a particular person or have the `in progress` label, that means someone is currently working on that issue. The `orbit` label means we will likely be working on this issue in the next week or two. The `ready` label means that the issue is one we have prioritized and will be working on in our next orbit (the Stellar term for a sprint) or two.
32+
Stellar.org also uses these same GitHub issues to keep track of what we are working on. If you see
33+
any issues that are assigned to a particular person or have the `in progress` label, that means
34+
someone is currently working on that issue this issue in the next week or two.
3135

3236
Of course, feel free to create a new issue if you think something needs to be added or fixed.
3337

38+
3439
## Making Changes
3540

3641
* Create a topic branch from where you want to base your work.
@@ -40,27 +45,37 @@ Of course, feel free to create a new issue if you think something needs to be ad
4045

4146
## Submitting Changes
4247

43-
* [Sign the Contributor License Agreement](https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform?usp=send_form).
44-
* All content, comments, and pull requests must follow the [Stellar Community Guidelines](https://www.stellar.org/community-guidelines/).
48+
* [Sign the Contributor License Agreement][cla].
49+
* All content, comments, and pull requests must follow the [Stellar Community
50+
Guidelines][community-guidelines] and [Code of Conduct][coc]
4551
* Push your changes to a topic branch in your fork of the repository.
46-
* Submit a pull request to the [docs repository](https://github.com/stellar/docs) in the Stellar organization.
47-
* Include a descriptive [commit message](https://github.com/erlang/otp/wiki/Writing-good-commit-messages).
48-
* Changes contributed via pull request should focus on a single issue at a time.
49-
* Rebase your local changes against the master branch. Resolve any conflicts that arise.
52+
* Submit a pull request to the [docs repository](https://github.com/stellar/docs) in the Stellar
53+
organization.
54+
* Include a descriptive [commit message][commit-msg].
55+
* Changes contributed via pull request should focus on a single issue at a time.
56+
* Rebase your local changes against the master branch. Resolve any conflicts that arise.
57+
5058

5159
At this point you're waiting on us. We like to at least comment on pull requests within three
52-
business days (typically, one business day). We may suggest some changes, improvements or alternatives.
60+
business days (typically, one business day). We may suggest some changes, improvements or
61+
alternatives.
5362

5463
# Additional Resources
5564

56-
* [Contributor License Agreement](https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform?usp=send_form)
5765
* [Explore the API](https://www.stellar.org/developers/reference/)
58-
* #dev channel on [Keybase](https://keybase.io/team/stellar.public)
59-
* #dev channel on [Slack](http://slack.stellar.org)
60-
* #stellar-dev IRC channel on freenode.org
66+
* [Stack Exchange](http://stellar.stackexchange.com/)
67+
* #dev-discussion channel on [Keybase](https://keybase.io/team/stellar.public)
68+
* [Contributor License Agreement][cla]
6169

6270
This document is inspired by:
6371

6472
* https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md
6573
* https://github.com/thoughtbot/factory_girl_rails/blob/master/CONTRIBUTING.md
6674
* https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md
75+
76+
[help-wanted]: https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Astellar+label%3A%22help+wanted%22
77+
[commit-msg]: https://github.com/erlang/otp/wiki/Writing-good-commit-messages
78+
[cla]: https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform?usp=send_form
79+
[community-guidelines]: https://www.stellar.org/community-guidelines/
80+
[coc]: https://github.com/stellar/.github/blob/master/CODE_OF_CONDUCT.md
81+

0 commit comments

Comments
 (0)