Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #751

Merged
merged 2 commits into from
Jan 2, 2020
Merged

Update CONTRIBUTING.md #751

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
186a4e4
Replace gitter with Discord; fix typos; Specify the need to sign commits
pscott Dec 20, 2019
5bac201
Add link to contributing document in lighthouse book
pscott Dec 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Replace gitter with Discord; fix typos; Specify the need to sign commits
  • Loading branch information
@pscott
pscott committed Dec 20, 2019
commit 186a4e4bcda2dae4c0cdda200b935b0f8c5a3f47
15 changes: 8 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributors Guide

Lighthouse is an open-source Ethereum 2.0 client. We we're community driven and
Lighthouse is an open-source Ethereum 2.0 client. We're community driven and
welcome all contribution. We aim to provide a constructive, respectful and fun
environment for collaboration.

Expand Down Expand Up @@ -31,7 +31,7 @@ same. We operate like a typical open-source project operating on GitHub: the
repository [Issues](https://github.com/sigp/lighthouse/issues) is where we
track what needs to be done and [Pull
Requests](https://github.com/sigp/lighthouse/pulls) is where code gets
reviewed. We use [gitter](https://gitter.im/sigp/lighthouse) to chat
reviewed. We use [discord](https://discord.gg/cyAszAh) to chat
informally.

### General Work-Flow
Expand All @@ -48,7 +48,7 @@ questions.
your changes in to the main repository.
4. Wait for the repository maintainers to **review your changes** to ensure the
issue is addressed satisfactorily. Optionally, mention your PR on
[gitter](https://gitter.im/sigp/lighthouse).
[discord](https://discord.gg/cyAszAh).
5. If the issue is addressed the repository maintainers will **merge your
pull-request** and you'll be an official contributor!

Expand Down Expand Up @@ -76,18 +76,19 @@ https://github.com/sigp/lighthouse.git` (pro-tip: [use SSH](https://help.github.
name of your branch isn't critical but it should be short and instructive.
E.g., if you're fixing a bug with serialization, you could name your branch
`fix_serialization_bug`.
4. Commit your changes and push them to your fork with `$ git push origin
4. Make sure you sign your commits. See [relevant doc](https://help.github.com/en/github/authenticating-to-github/about-commit-signature-verification).
5. Commit your changes and push them to your fork with `$ git push origin
your_feature_name`.
5. Go to your fork on github.com and use the web interface to create a pull
6. Go to your fork on github.com and use the web interface to create a pull
request into the sigp/lighthouse repo.

From there, the repository maintainers will review the PR and either accept it
or provide some constructive feedback.

There's great
There's a great
[guide](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/)
by Rob Allen that provides much more detail on each of these steps, if you're
having trouble. As always, jump on [gitter](https://gitter.im/sigp/lighthouse)
having trouble. As always, jump on [discord](https://discord.gg/cyAszAh)
if you get stuck.


Expand Down