mirror/lighthouse-pulse
1
0
Fork 0
mirror of https://gitlab.com/pulsechaincom/lighthouse-pulse.git synced 2024-12-22 11:41:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md (#751)

Browse Source 
* Replace gitter with Discord; fix typos; Specify the need to sign commits

* Add link to contributing document in lighthouse book
This commit is contained in:
pscott 2020-01-03 00:45:53 +01:00 committed by Paul Hauner
parent 01ac60d638
commit 50ea669e1e
2 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@ -1,6 +1,6 @@
# Contributors Guide # 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 welcome all contribution. We aim to provide a constructive, respectful and fun
environment for collaboration. environment for collaboration.
@ -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 repository [Issues](https://github.com/sigp/lighthouse/issues) is where we
track what needs to be done and [Pull track what needs to be done and [Pull
Requests](https://github.com/sigp/lighthouse/pulls) is where code gets 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. informally.
### General Work-Flow ### General Work-Flow
@ -48,7 +48,7 @@ questions.
your changes in to the main repository. your changes in to the main repository.
4. Wait for the repository maintainers to **review your changes** to ensure the 4. Wait for the repository maintainers to **review your changes** to ensure the
issue is addressed satisfactorily. Optionally, mention your PR on 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 5. If the issue is addressed the repository maintainers will **merge your
pull-request** and you'll be an official contributor! pull-request** and you'll be an official contributor!
@ -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. 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 E.g., if you're fixing a bug with serialization, you could name your branch
`fix_serialization_bug`. `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`. 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. request into the sigp/lighthouse repo.
From there, the repository maintainers will review the PR and either accept it From there, the repository maintainers will review the PR and either accept it
or provide some constructive feedback. 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/) [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 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. if you get stuck.

9
book/src/contributing.md
View File

@ -12,13 +12,14 @@ to work on.
To start contributing, To start contributing,
1. Setup a [development environment](./setup.md). 1. Read our [how to contribute](https://github.com/sigp/lighthouse/blob/master/CONTRIBUTING.md) document.
2. Browse through the [open issues](https://github.com/sigp/lighthouse/issues) 2. Setup a [development environment](./setup.md).
3. Browse through the [open issues](https://github.com/sigp/lighthouse/issues)
(tip: look for the [good first (tip: look for the [good first
issue](https://github.com/sigp/lighthouse/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) issue](https://github.com/sigp/lighthouse/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
tag). tag).
3. Comment on an issue before starting work. 4. Comment on an issue before starting work.
4. Share your work via a pull-request. 5. Share your work via a pull-request.
If you have questions, please reach out via If you have questions, please reach out via
[Discord](https://discord.gg/cyAszAh). [Discord](https://discord.gg/cyAszAh).