Skip to content
This repository was archived by the owner on Jul 1, 2024. It is now read-only.

Commit c5473bb

Browse files
author
Jed McCaleb
committed
Update CONTRIBUTING.md
1 parent 6bb6553 commit c5473bb

File tree

1 file changed

+2
-54
lines changed

1 file changed

+2
-54
lines changed

CONTRIBUTING.md

+2-54
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,6 @@
11
# How to contribute
22

3-
Your contributions to the Stellar network will help improve the world’s financial
4-
infrastructure, faster.
3+
Please read the [Contribution Guide](https://github.com/stellar/docs/blob/master/CONTRIBUTING.md).
54

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.
5+
Then please [sign the Contributor License Agreement](https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform?usp=send_form).
96

10-
## Getting Started
11-
12-
* Create a GitHub issue for your contribution, assuming one does not already exist.
13-
* Clearly describe the issue including steps to reproduce if it is a bug.
14-
* Fork the repository on GitHub
15-
16-
## Making Changes
17-
18-
* Create a topic branch from where you want to base your work.
19-
* This is usually the master branch.
20-
* Please avoid working directly on the `master` branch.
21-
* Make sure you have added the necessary tests for your changes, and make sure all tests pass.
22-
23-
## Submitting Changes
24-
25-
* <a href="https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform?usp=send_form">Sign the Contributor License Agreement</a>.
26-
* All content, comments, and pull requests must follow the [Stellar Community Guidelines](https://www.stellar.org/community-guidelines/).
27-
* Push your changes to a topic branch in your fork of the repository.
28-
* Submit a pull request to the [developers repository](https://github.com/stellar/developers) in the Stellar organization.
29-
* Include a descriptive [commit message](https://github.com/erlang/otp/wiki/Writing-good-commit-messages).
30-
* Changes contributed via pull request should focus on a single issue at a time.
31-
* Rebase your local changes against the master branch. Resolve any conflicts that arise.
32-
33-
At this point you're waiting on us. We like to at least comment on pull requests within three
34-
business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.
35-
36-
## Making Trivial Changes
37-
38-
### Documentation
39-
For changes of a trivial nature to comments and documentation, it is not
40-
always necessary to create a new GitHub issue. In this case, it is
41-
appropriate to start the first line of a commit with 'doc' instead of
42-
an issue number.
43-
44-
# Additional Resources
45-
46-
* <a href="https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform?usp=send_form">Contributor License Agreement</a>
47-
* [Readme for Stellar/Developers](https://github.com/stellar/developers/blob/master/README.md)
48-
* #stellar-dev IRC channel on freenode.org
49-
* #dev channel on [Slack](http://slack.stellar.org)
50-
51-
52-
This document is inspired by:
53-
54-
https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md
55-
56-
https://github.com/thoughtbot/factory_girl_rails/blob/master/CONTRIBUTING.md
57-
58-
https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md

0 commit comments

Comments
 (0)