From b085f5e7aba6794a496e93f229e196ab02e392fe Mon Sep 17 00:00:00 2001 From: Shane Bammel Date: Wed, 1 Feb 2023 15:41:47 -0600 Subject: [PATCH] Update repo docs --- CONTRIBUTING.md | 123 ------------------------------------------------ README.md | 67 ++++---------------------- SECURITY.md | 10 +--- 3 files changed, 11 insertions(+), 189 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index a408fcdd5..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,123 +0,0 @@ -# Contributors Guide -[![GitPOAP badge](https://public-api.gitpoap.io/v1/repo/sigp/lighthouse/badge)](https://www.gitpoap.io/gh/sigp/lighthouse) - -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. - -We are active contributors to the [Ethereum 2.0 specification](https://github.com/ethereum/eth2.0-specs) and attend all [Eth -2.0 implementers calls](https://github.com/ethereum/eth2.0-pm). - -This guide is geared towards beginners. If you're an open-source veteran feel -free to just skim this document and get straight into crushing issues. - -## Why Contribute - -There are many reasons you might contribute to Lighthouse. For example, you may -wish to: - -- contribute to the Ethereum ecosystem. -- establish yourself as a layer-1 Ethereum developer. -- work in the amazing Rust programming language. -- learn how to participate in open-source projects. -- expand your software development skills. -- flex your skills in a public forum to expand your career - opportunities (or simply for the fun of it). -- grow your network by working with core Ethereum developers. - -## How to Contribute - -Regardless of the reason, the process to begin contributing is very much the -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 [discord](https://discord.gg/cyAszAh) to chat -informally. - -### General Work-Flow - -We recommend the following work-flow for contributors: - -1. **Find an issue** to work on, either because it's interesting or suitable to - your skill-set. Use comments to communicate your intentions and ask -questions. -2. **Work in a feature branch** of your personal fork - (github.com/YOUR_NAME/lighthouse) of the main repository - (github.com/sigp/lighthouse). -3. Once you feel you have addressed the issue, **create a pull-request** with - `unstable` as the base branch to merge your changes into 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 -[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! - -Generally, you find an issue you'd like to work on and announce your intentions -to start work in a comment on the issue. Then, do your work on a separate -branch (a "feature branch") in your own fork of the main repository. Once -you're happy and you think the issue has been addressed, create a pull request -into the main repository. - -### First-time Set-up - -First time contributors can get their git environment up and running with these -steps: - -1. [Create a - fork](https://help.github.com/articles/fork-a-repo/#fork-an-example-repository) -and [clone -it](https://help.github.com/articles/fork-a-repo/#step-2-create-a-local-clone-of-your-fork) -to your local machine. -2. [Add an _"upstream"_ - branch](https://help.github.com/articles/fork-a-repo/#step-3-configure-git-to-sync-your-fork-with-the-original-spoon-knife-repository) -that tracks github.com/sigp/lighthouse using `$ git remote add upstream -https://github.com/sigp/lighthouse.git` (pro-tip: [use SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) instead of HTTPS). -3. Create a new feature branch with `$ git checkout -b your_feature_name`. The - 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. 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`. -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 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 [discord](https://discord.gg/cyAszAh) -if you get stuck. - - -## FAQs - -### I don't think I have anything to add - -There's lots to be done and there's all sorts of tasks. You can do anything -from correcting typos through to writing core consensus code. If you reach out, -we'll include you. - -### I'm not sure my Rust is good enough - -We're open to developers of all levels. If you create a PR and your code -doesn't meet our standards, we'll help you fix it and we'll share the reasoning -with you. Contributing to open-source is a great way to learn. - -### I'm not sure I know enough about Ethereum 2.0 - -No problems, there's plenty of tasks that don't require extensive Ethereum -knowledge. You can learn about Ethereum as you go. - -### I'm afraid of making a mistake and looking silly - -Don't be. We're all about personal development and constructive feedback. If you -make a mistake and learn from it, everyone wins. - -### I don't like the way you do things - -Please, make an issue and explain why. We're open to constructive criticism and -will happily change our ways. diff --git a/README.md b/README.md index 11a87b81f..1bcb0b5ea 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,34 @@ -# Lighthouse: Ethereum consensus client +# Lighthouse-Pulse: A PulseChain Consensus Client Written in Rust -An open-source Ethereum consensus client, written in Rust and maintained by Sigma Prime. +This is the core repository for Lighthouse-Pulse, a [Rust](https://www.rust-lang.org/) implementation of the [Ethereum Consensus](https://ethereum.org/en/eth2/) specification, originally developed by [Sigma Prime](https://sigmaprime.io/) and modified for usage with [PulseChain](https://pulsechain.com/). See the [Changelog](https://gitlab.com/pulsechaincom/lighthouse-pulse/-/releases) for details of the latest releases and upcoming breaking changes. -[![Book Status]][Book Link] [![Chat Badge]][Chat Link] - -[Chat Badge]: https://img.shields.io/badge/chat-discord-%237289da -[Chat Link]: https://discord.gg/cyAszAh -[Book Status]:https://img.shields.io/badge/user--docs-unstable-informational -[Book Link]: https://lighthouse-book.sigmaprime.io -[stable]: https://github.com/sigp/lighthouse/tree/stable -[unstable]: https://github.com/sigp/lighthouse/tree/unstable -[blog]: https://lighthouse-blog.sigmaprime.io +> Credit to the [Sigma Prime](https://sigmaprime.io/) team for the original implementation of [Lighthouse](https://github.com/sigp/lighthouse). [Documentation](https://lighthouse-book.sigmaprime.io) -![Banner](https://i.postimg.cc/hjdTGKPd/photo-2020-10-23-09-52-16.jpg) - ## Overview -Lighthouse is: +Lighthouse-Pulse is: -- Ready for use on Ethereum consensus mainnet. +- Ready for use on Ethereum consensus mainnet & PulseChain consensus testnets/mainnet. - Fully open-source, licensed under Apache 2.0. - Security-focused. Fuzzing techniques have been continuously applied and several external security reviews have been performed. - Built in [Rust](https://www.rust-lang.org), a modern language providing unique safety guarantees and excellent performance (comparable to C++). -- Funded by various organisations, including Sigma Prime, the - Ethereum Foundation, ConsenSys, the Decentralization Foundation and private individuals. -- Actively involved in the specification and security analysis of the - Ethereum proof-of-stake consensus specification. ## Staking Deposit Contract -The Lighthouse team acknowledges -[`0x00000000219ab540356cBB839Cbe05303d7705Fa`](https://etherscan.io/address/0x00000000219ab540356cbb839cbe05303d7705fa) -as the canonical staking deposit contract address. +The PulseChain team acknowledges `0x3693693693693693693693693693693693693693` as the canonical staking deposit contract address. ## Documentation -The [Lighthouse Book](https://lighthouse-book.sigmaprime.io) contains information for users and +The upstream [Lighthouse Book](https://lighthouse-book.sigmaprime.io) contains information for users and developers. -The Lighthouse team maintains a blog at [lighthouse-blog.sigmaprime.io][blog] which contains periodic -progress updates, roadmap insights and interesting findings. - -## Branches - -Lighthouse maintains two permanent branches: - -- [`stable`][stable]: Always points to the latest stable release. - - This is ideal for most users. -- [`unstable`][unstable]: Used for development, contains the latest PRs. - - Developers should base their PRs on this branch. - -## Contributing - -Lighthouse welcomes contributors. - -If you are looking to contribute, please head to the -[Contributing](https://lighthouse-book.sigmaprime.io/contributing.html) section -of the Lighthouse book. - ## Contact -The best place for discussion is the [Lighthouse Discord -server](https://discord.gg/cyAszAh). +For additional support, feel free to join [the PulseChain telegram channel](https://t.me/PulseDEV). -Sign up to the [Lighthouse Development Updates](https://eepurl.com/dh9Lvb) mailing list for email -notifications about releases, network status and other important information. +## License -Encrypt sensitive messages using our [PGP -key](https://keybase.io/sigp/pgp_keys.asc?fingerprint=15e66d941f697e28f49381f426416dc3f30674b0). - -## Donations - -Lighthouse is an open-source project and a public good. Funding public goods is -hard and we're grateful for the donations we receive from the community via: - -- [Gitcoin Grants](https://gitcoin.co/grants/25/lighthouse-ethereum-20-client). -- Ethereum address: `0x25c4a76E7d118705e7Ea2e9b7d8C59930d8aCD3b` (donation.sigmaprime.eth). +[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) diff --git a/SECURITY.md b/SECURITY.md index 6fe004866..2498c2e82 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,12 +2,4 @@ ## Supported Versions -Please see [Releases](https://github.com/sigp/lighthouse/releases/). We recommend using the [most recently released version](https://github.com/sigp/lighthouse/releases/latest). - -## Reporting a Vulnerability - -Please send vulnerability reports to security@sigmaprime.io and encrypt sensitive messages using our [PGP -key](https://keybase.io/sigp/pgp_keys.asc?fingerprint=15e66d941f697e28f49381f426416dc3f30674b0). - -**Please do not file a public ticket** mentioning the vulnerability, as doing so could increase the likelihood of the vulnerability being used before a fix has been created, released and installed on the network. - +Please see [Releases](https://gitlab.com/pulsechaincom/lighthouse-pulse/-/releases). We recommend using the most recently released version.