Skip to content

Commit 6d792b4

Browse files
authored
Revise contributors guide (#5720)
* Revise contributors guide.
1 parent 5135a77 commit 6d792b4

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

CONTRIBUTING.md

+26-16
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Contributors Guide
2+
23
[![GitPOAP badge](https://public-api.gitpoap.io/v1/repo/sigp/lighthouse/badge)](https://www.gitpoap.io/gh/sigp/lighthouse)
34

4-
Lighthouse is an open-source Ethereum 2.0 client. We're community driven and
5+
Lighthouse is an open-source Ethereum consensus client. We're community driven and
56
welcome all contribution. We aim to provide a constructive, respectful and fun
67
environment for collaboration.
78

8-
We are active contributors to the [Ethereum 2.0 specification](https://github.com/ethereum/eth2.0-specs) and attend all [Eth
9-
2.0 implementers calls](https://github.com/ethereum/eth2.0-pm).
9+
We are active contributors to
10+
the [Ethereum Proof-of-Stake Consensus specification](https://github.com/ethereum/consensus-specs) and attend
11+
all [Ethereum implementers calls](https://github.com/ethereum/pm/).
1012

1113
This guide is geared towards beginners. If you're an open-source veteran feel
1214
free to just skim this document and get straight into crushing issues.
@@ -41,21 +43,21 @@ We recommend the following work-flow for contributors:
4143

4244
1. **Find an issue** to work on, either because it's interesting or suitable to
4345
your skill-set. Use comments to communicate your intentions and ask
44-
questions.
46+
questions.
4547
2. **Work in a feature branch** of your personal fork
4648
(github.com/YOUR_NAME/lighthouse) of the main repository
4749
(github.com/sigp/lighthouse).
4850
3. Once you feel you have addressed the issue, **create a pull-request** with
4951
`unstable` as the base branch to merge your changes into the main repository.
5052
4. Wait for the repository maintainers to **review your changes** to ensure the
5153
issue is addressed satisfactorily. Optionally, mention your PR on
52-
[discord](https://discord.gg/cyAszAh).
54+
[discord](https://discord.gg/cyAszAh).
5355
5. If the issue is addressed the repository maintainers will **merge your
5456
pull-request** and you'll be an official contributor!
5557

5658
Generally, you find an issue you'd like to work on and announce your intentions
5759
to start work in a comment on the issue. Then, do your work on a separate
58-
branch (a "feature branch") in your own fork of the main repository. Once
60+
branch (a "feature branch") in your own fork of the main repository. Once
5961
you're happy and you think the issue has been addressed, create a pull request
6062
into the main repository.
6163

@@ -66,18 +68,20 @@ steps:
6668

6769
1. [Create a
6870
fork](https://help.github.com/articles/fork-a-repo/#fork-an-example-repository)
69-
and [clone
70-
it](https://help.github.com/articles/fork-a-repo/#step-2-create-a-local-clone-of-your-fork)
71-
to your local machine.
71+
and [clone
72+
it](https://help.github.com/articles/fork-a-repo/#step-2-create-a-local-clone-of-your-fork)
73+
to your local machine.
7274
2. [Add an _"upstream"_
7375
branch](https://help.github.com/articles/fork-a-repo/#step-3-configure-git-to-sync-your-fork-with-the-original-spoon-knife-repository)
74-
that tracks github.com/sigp/lighthouse using `$ git remote add upstream
75-
https://github.com/sigp/lighthouse.git` (pro-tip: [use SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) instead of HTTPS).
76+
that tracks github.com/sigp/lighthouse using `$ git remote add upstream
77+
https://github.com/sigp/lighthouse.git` (
78+
pro-tip: [use SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) instead of HTTPS).
7679
3. Create a new feature branch with `$ git checkout -b your_feature_name`. The
7780
name of your branch isn't critical but it should be short and instructive.
78-
E.g., if you're fixing a bug with serialization, you could name your branch
79-
`fix_serialization_bug`.
80-
4. Make sure you sign your commits. See [relevant doc](https://help.github.com/en/github/authenticating-to-github/about-commit-signature-verification).
81+
E.g., if you're fixing a bug with serialization, you could name your branch
82+
`fix_serialization_bug`.
83+
4. Make sure you sign your commits.
84+
See [relevant doc](https://help.github.com/en/github/authenticating-to-github/about-commit-signature-verification).
8185
5. Commit your changes and push them to your fork with `$ git push origin
8286
your_feature_name`.
8387
6. Go to your fork on github.com and use the web interface to create a pull
@@ -92,22 +96,28 @@ by Rob Allen that provides much more detail on each of these steps, if you're
9296
having trouble. As always, jump on [discord](https://discord.gg/cyAszAh)
9397
if you get stuck.
9498

99+
Additionally,
100+
the ["Contributing to Lighthouse" section](https://lighthouse-book.sigmaprime.io/contributing.html#contributing-to-lighthouse)
101+
of the Lighthouse Book provides more details on the setup.
95102

96103
## FAQs
97104

98105
### I don't think I have anything to add
99106

100107
There's lots to be done and there's all sorts of tasks. You can do anything
101-
from correcting typos through to writing core consensus code. If you reach out,
108+
from enhancing documentation through to writing core consensus code. If you reach out,
102109
we'll include you.
103110

111+
Please note, to maintain project quality, we may not accept PRs for small typos or changes
112+
with minimal impact.
113+
104114
### I'm not sure my Rust is good enough
105115

106116
We're open to developers of all levels. If you create a PR and your code
107117
doesn't meet our standards, we'll help you fix it and we'll share the reasoning
108118
with you. Contributing to open-source is a great way to learn.
109119

110-
### I'm not sure I know enough about Ethereum 2.0
120+
### I'm not sure I know enough about Ethereum
111121

112122
No problems, there's plenty of tasks that don't require extensive Ethereum
113123
knowledge. You can learn about Ethereum as you go.

0 commit comments

Comments
 (0)