docs: batch commit typos and update contributor readme (#7312)

* batch commit typos and update contributor readme * update donation text Co-authored-by: Nico Flaig <[email protected]> * correct spelling Co-authored-by: Nico Flaig <[email protected]> --------- Co-authored-by: Nico Flaig <[email protected]>
ChainSafe · Dec 19, 2024 · ffdfb2e · ffdfb2e
1 parent 8c7eaf8
commit ffdfb2e
Show file tree

Hide file tree

Showing 14 changed files with 19 additions and 18 deletions.
diff --git a/.wordlist.txt b/.wordlist.txt
@@ -198,7 +198,6 @@ namespaces
 nodemodule
 orchestrator
 osx
-overriden
 params
 performant
 pid

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -126,6 +126,8 @@ Unsure where to begin contributing to Lodestar? Here are some ideas!
 5. Make an open pull request when you're ready for it to be reviewed. We review PRs on a regular basis. See Pull request etiquette for more information.
 6. You may be asked to sign a Contributor License Agreement (CLA). We make it relatively painless with CLA-bot.
 
+Please note that trivial, non-code contributions such as spelling, grammar, typos, corrections, comments and link fixes are not acceptable pull requests. Although we appreciate the effort to fix these valid concerns, it is not practical for us to run our CI systems to accommodate minor external contributions which generate minimal value for the purpose of contribution/airdrop farming. It would be appreciated for you to open up an issue instead for our team to aggregate these types of contributions into a batch commit.
+
 ## Github Style Guide
 
 **Branch Naming**

diff --git a/README.md b/README.md
@@ -70,9 +70,9 @@ Read our [contributors document](/CONTRIBUTING.md), [submit an issue](https://gi
 
 ## Meetings
 
-Weekly contributor meetings are public and announced on Discord. Feel free to check out our meeting notes and documents on [HackMD](https://hackmd.io/@wemeetagain/rJTEOdqPS/%2FXBzvaQgMTyyMJuToWAEDjw). Post-September 2021, meeting notes can be found on the [Lodestar Wiki Page](https://github.com/ChainSafe/lodestar/wiki).
+Weekly contributor meetings are posted under [Discussions](https://github.com/ChainSafe/lodestar/discussions) and topics are welcomed by any participant in the relevant meeting thread. Feel free to check out our meeting notes and documents on [HackMD](https://hackmd.io/@wemeetagain/rJTEOdqPS/%2FXBzvaQgMTyyMJuToWAEDjw). Post-September 2021, meeting notes can be found on the [Lodestar Wiki Page](https://github.com/ChainSafe/lodestar/wiki).
 
 ## Donations
 
 We are a local group of Toronto open-source developers. As such, all of our open-source work is funded by grants. We all take the time out of our hectic lives to contribute to the Ethereum ecosystem.
-If you want to donate, you can send us ETH at the following address: `lodestar.chainsafe.eth`
+If you want to donate, you can find the ETH address under "Sponsor this project" on this repository.
diff --git a/RELEASE.md b/RELEASE.md
@@ -69,7 +69,7 @@ Tagging a release candidate will trigger CI to publish to NPM, dockerhub, and Gi
 
 Once a release candidate is created, the Lodestar team begins a testing period.
 
-If there is a bug discovered during the testing period which significantly impacts performance, security, or stability, and it is determined that it is no longer prudent to promote the `rc.x` candidate to `stable`, then it will await a bug fix by the team. The fix will be committed to `unstable` first, then cherrypicked into the `rc/v1.1.0` branch. Then we publish and promote the new commit to `rc.x+1`. The 3 day testing period will reset.
+If there is a bug discovered during the testing period which significantly impacts performance, security, or stability, and it is determined that it is no longer prudent to promote the `rc.x` candidate to `stable`, then it will await a bug fix by the team. The fix will be committed to `unstable` first, then cherrypicked into the `rc/v1.1.0` branch. Then we publish and promote the new commit to `rc.x+1`. The 3-day testing period will reset.
 
 For example: After 3-5 days of testing, is performance equal to or better than latest stable?
 

diff --git a/docs/pages/contribution/testing/index.md b/docs/pages/contribution/testing/index.md
@@ -2,7 +2,7 @@
 
 Testing is critical to the Lodestar project and there are many types of tests that are run to build a product that is both effective AND efficient. This page will help to break down the different types of tests you will find in the Lodestar repo.
 
-There are few flags you can set through env variables to override behavior of testing and it's output.
+There are a few flags you can set through env variables to override behavior of testing and its output.
 
 | ENV variable        | Effect | Impact                                                                                                                    |
 | ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------- |
@@ -24,7 +24,7 @@ Node.js is an unforgiving virtual machine when it comes to high performance, mul
 
 ### End-To-End Tests
 
-E2E test are where Lodestar is run in its full form, often from the CLI as a user would to check that the system as a whole works as expected. These tests are meant to exercise the entire system in isolation and there is no network interaction, nor interaction with any other code outside of Lodestar. See the [End-To-End Testing](./end-to-end-tests.md) page for more information.
+E2E tests are where Lodestar is run in its full form, often from the CLI as a user would to check that the system as a whole works as expected. These tests are meant to exercise the entire system in isolation and there is no network interaction, nor interaction with any other code outside of Lodestar. See the [End-To-End Testing](./end-to-end-tests.md) page for more information.
 
 ### Integration Tests
 

diff --git a/docs/pages/contribution/tools/heap-dumps.md b/docs/pages/contribution/tools/heap-dumps.md
@@ -40,7 +40,7 @@ Click on the `Open dedicated DevTools for Node` link to open the node specific w
 
 ![Memory Tab](/images/heap-dumps/memory-tab.png)
 
-Load the profile by either right clicking on the left pane or by clicking the `Load` button at the bottom.
+Load the profile by either right-clicking on the left pane or by clicking the `Load` button at the bottom.
 
 ![Load Profile](/images/heap-dumps/load-profile.png)
 
@@ -70,7 +70,7 @@ Having a good understanding of the codebase will help to narrow down where to lo
 
 _**note: collecting a native heap dump is only supported on linux, analysis can be done from linux or Mac**_
 
-There are several tools that can be used to do native heap dump analysis. The most common are [`massif`](https://valgrind.org/docs/manual/ms-manual.html) from the [`Valgrind`](https://valgrind.org/) suite, google's [`gperftools`](https://github.com/gperftools/gperftools) and `heaptrack` from [KDE](https://community.kde.org/Main_Page). Of the three, `heaptrack` is the most user friendly tool, and it is specifically designed for the task. It is much faster than `Valgrind`, easier to integrate than `gperftools` and also includes a gui for result analysis. Often times there are also memory allocations that are not related to memory leaks, and tools like `Valgrind` and `gperftools` become less useful. This is why `heaptrack` is the recommended tool for heap dump analysis on Lodestar.
+There are several tools that can be used to do native heap dump analysis. The most common are [`massif`](https://valgrind.org/docs/manual/ms-manual.html) from the [`Valgrind`](https://valgrind.org/) suite, google's [`gperftools`](https://github.com/gperftools/gperftools) and `heaptrack` from [KDE](https://community.kde.org/Main_Page). Of the three, `heaptrack` is the most user-friendly tool, and it is specifically designed for the task. It is much faster than `Valgrind`, easier to integrate than `gperftools` and also includes a gui for result analysis. Often times there are also memory allocations that are not related to memory leaks, and tools like `Valgrind` and `gperftools` become less useful. This is why `heaptrack` is the recommended tool for heap dump analysis on Lodestar.
 
 There are a few things that will make the results with `heaptrack` far better. The most important is using debug builds of all libraries included in a binary, including the application itself. This will make the results usable. Not to say that they will be useless without debug symbols but it will be kinda tough to optimize functions without knowing the function names nor the file and line numbers.
 

diff --git a/docs/pages/faqs.md b/docs/pages/faqs.md
@@ -1,6 +1,6 @@
 # Frequently Asked Questions
 
-This section of the documentation will cover common questions and encounters often asked by users and developers.
+This section of the documentation will cover common questions and common encounters by users and developers.
 
 ## Tooling
 

diff --git a/docs/pages/introduction.md b/docs/pages/introduction.md
@@ -1,6 +1,6 @@
 # Introduction
 
-Ethereum is one of the most profoundly important inventions in recent history. It is a decentralized, open-source blockchain featuring smart contract functionality. It is the second-largest cryptocurrency by market capitalization, after Bitcoin, and is the second largest blockchain by market capitalization. Ethereum was proposed in 2013 by programmer Vitalik Buterin. Development was crowdfunded in 2014, and the network went live on 30 July 2015, with 72 million coins premined. ChainSafe was founded not too long afterwards in 2017 and has been actively working in the Ethereum ecosystem ever since. We are proud to develop Lodestar, the only TypeScript based consensus client, and to present this documentation as a resource for the Ethereum community.
+Ethereum is one of the most profoundly important inventions in recent history. It is a decentralized, open-source blockchain featuring smart contract functionality. It is the second-largest cryptocurrency by market capitalization, after Bitcoin, and is the second-largest blockchain by market capitalization. Ethereum was proposed in 2013 by programmer Vitalik Buterin. Development was crowdfunded in 2014, and the network went live on 30 July 2015, with 72 million coins premined. ChainSafe was founded not too long afterwards in 2017 and has been actively working in the Ethereum ecosystem ever since. We are proud to develop Lodestar, the only TypeScript based consensus client, and to present this documentation as a resource for the Ethereum community.
 
 ## Proof of Stake
 

diff --git a/docs/pages/run/logging-and-metrics/client-monitoring.md b/docs/pages/run/logging-and-metrics/client-monitoring.md
@@ -27,7 +27,7 @@ When sending data to a remote service you should be conscious about security:
 
 - Only use a service that you trust as this will send information which may identify you
   and associate your validators, IP address and other personal information.
-- Always use a HTTPS connection (i.e. a URL starting with `https://`) to prevent the traffic
+- Always use an HTTPS connection (i.e. a URL starting with `https://`) to prevent the traffic
   from being intercepted in transit and leaking information.
 
 :::

diff --git a/packages/light-client/README.md b/packages/light-client/README.md
@@ -18,7 +18,7 @@ The evolution of light clients is emblematic of the broader trajectory of Ethere
 
 ## Requirements for Running a Light-Client
 
-Access to an beacon node that supports the light client specification is necessary. The client must support the following routes from the [consensus API spec](https://github.com/ethereum/beacon-APIs/tree/v2.5.0/apis/beacon/light_client):
+Access to a beacon node that supports the light client specification is necessary. The client must support the following routes from the [consensus API spec](https://github.com/ethereum/beacon-APIs/tree/v2.5.0/apis/beacon/light_client):
 
 - [`GET /eth/v1/beacon/light_client/updates`](https://ethereum.github.io/beacon-APIs/?urls.primaryName=v2.5.0#/Beacon/getLightClientUpdatesByRange)
 - [`GET /eth/v1/beacon/light_client/optimistic_update`](https://ethereum.github.io/beacon-APIs/?urls.primaryName=v2.5.0#/Beacon/getLightClientOptimisticUpdate)
@@ -32,7 +32,7 @@ You can find more information about the light-client protocol in the [specificat
 ## Getting started
 
 - Follow the [installation guide](https://chainsafe.github.io/lodestar/run/getting-started/installation) to install Lodestar.
-- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/advanced-topics/setting-up-a-testnet).
+- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/contribution/advanced-topics/setting-up-a-testnet).
 
 ## Light-Client CLI Example
 
@@ -92,7 +92,7 @@ lightclient.emitter.on(LightclientEvent.lightClientOptimisticHeader, async (opti
 
 ## Browser Integration
 
-If you want to use Lightclient in browser and facing some issues in building it with bundlers like webpack, vite. We suggest to use our distribution build. The support for single distribution build is started from `1.20.0` version.
+If you want to use Lightclient in browser and are facing some issues in building it with bundlers like webpack, vite. We suggest using our distribution build. The support for single distribution build is started from `1.20.0` version.
 
 Directly link the dist build with the `<script />` tag with tools like unpkg or other. e.g.
 

diff --git a/packages/params/README.md b/packages/params/README.md
@@ -70,7 +70,7 @@ Important Notes:
 - Interacting with and understanding the active preset is only necessary in very limited testing environments, like for ephemeral testnets
 - The `minimal` preset is NOT compatible with the `mainnet` preset.
 - using `setActivePreset` may be dangerous, and only should be run once before loading any other libraries. All downstream Lodestar libraries expect the active preset to never change.
-- Preset values can be overriden by executing `setActivePreset(presetName: PresetName, overrides?: Partial<BeaconPreset>)` and supplying values to override.
+- Preset values can be overridden by executing `setActivePreset(presetName: PresetName, overrides?: Partial<BeaconPreset>)` and supplying values to override.
 - The Lodestar CLI exposes `setActivePreset` through `--presetFile` flag which allows to override the active preset with custom values from file.
 
 ## License

diff --git a/packages/prover/README.md b/packages/prover/README.md
@@ -153,7 +153,7 @@ You will need to go over the [specification](https://github.com/ethereum/beacon-
 ## Getting started
 
 - Follow the [installation guide](https://chainsafe.github.io/lodestar/run/getting-started/installation) to install Lodestar.
-- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/advanced-topics/setting-up-a-testnet).
+- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/contribution/advanced-topics/setting-up-a-testnet).
 
 ## Contributors
 

diff --git a/packages/utils/src/yaml/int.ts b/packages/utils/src/yaml/int.ts
@@ -1,4 +1,4 @@
-// Forked from https://github.com/nodeca/js-yaml/blob/master/lib/js-yaml/type/int.js
+// Forked from https://github.com/nodeca/js-yaml/blob/master/lib/type/int.js
 // Currently only supports loading ints
 import yaml from "js-yaml";
 

diff --git a/scripts/await-release.sh b/scripts/await-release.sh
@@ -3,7 +3,7 @@
 # Should ONLY run on CI/GA for releases, installing `jq` for Ubuntu latest
 sudo apt install jq # sudo without password on ubuntu-latest
 
-# Using the lodestar-cli packacke to reference against
+# Using the lodestar-cli package to reference against
 declare PACKAGE="@chainsafe/lodestar"
 
 # Using `npm view -j` to get all available versions as JSON