71 Commits

Author SHA1 Message Date
Phil Ngo
f2a741bbe4 docs: update contributing.md to include AI disclosure (#8498)
**Motivation**

Recently, we have been experiencing many instances of AI generated slop
submitted by first time contributors and a policy rework is needed to
ensure our time is respected whilst allowing an external contributor
freely contribute to further enhancing this project. This proposal
ensures that new contributors self-disclose any use of AI technologies
as part of their submission to minimize time waste and allow issues to
be resolved with thorough understanding of the output at hand.

**Description**

This PR:
- Adds an AI Assistance Notice to contribution.md
- Moves important context for first time contributors to the top of the
document
- Corrects minor grammar

Additional credit to @nflaig and [Ghostly's
policy](https://github.com/ghostty-org/ghostty/blob/main/CONTRIBUTING.md#ai-assistance-notice)
to approach minimizing this problem.

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2025-10-06 14:47:52 -04:00
bing
4637c6a21a docs: add bindings error to common issues (#8038)
**Motivation**

Ran into an issue with bindings not being found while setting
`lodestar`. Found some old issues([#3037], [#1396]) dating back to 2020
indicating that others also ran into the same issue in the past.

**Description**

Added a short note to `CONTRIBUTING.md` describing the error and the
solution.
2025-07-08 10:00:22 -04:00
Phil Ngo
672665e350 chore: change remaining package licenses from LGPL-v3 to Apache-2.0 (#7915)
**Motivation**

Discussions were previously ongoing to make our entire monorepo and
packages within Apache-2.0 license. The only remaining packages which
were previously under LGPL-v3 were the beacon node, cli, validator
packages.

**Description**

This PR marks the switch for all packages in the Lodestar monorepository
to be under one license, Apache-2.0 of which the majority of consensus
clients have adopted. This PR:

- Removes any instance of LGPLv3
- Switches all LICENSE to adopt Apache-2.0
- Removes CLA bot signing as part of our contribution.md
2025-06-05 08:13:18 -04:00
Nazar Hussain
30652b83f0 docs: add PR workflow section in contribution guide (#7602)
**Motivation**

Document the PR workflow based on the last team
[discussion](https://github.com/ChainSafe/lodestar/discussions/7554#discussioncomment-12537466).

**Description**

- Explain different natures of PRs
- Explain steps how to open and manage those PRs. 

**Steps to test or reproduce**

- Run all tests

---------

Co-authored-by: Matthew Keil <me@matthewkeil.com>
Co-authored-by: Nico Flaig <nflaig@protonmail.com>
2025-03-26 14:10:21 -04:00
Nazar Hussain
51efa3d604 chore: update the test runner (#7404)
**Motivation**

Update vitest and browser engine.

**Description**

- Move root level shared configs to `configs` directory
- Update to vitest 3.x
- Migrate from `webdriverio` to `playwright` which is more stable and
recommended by Vitest.

**NOTE**
Reverted the `playwright` upgrade. See the comments. 


d2a7af0308/configs/vitest.config.base.browser.ts (L41-L43)

**Steps to test or reproduce**

Run all tests
2025-02-27 10:27:43 -05:00
Phil Ngo
ffdfb2e517 docs: batch commit typos and update contributor readme (#7312)
* batch commit typos and update contributor readme

* update donation text

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* correct spelling

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

---------

Co-authored-by: Nico Flaig <nflaig@protonmail.com>
2024-12-19 19:44:42 +00:00
Nazar Hussain
5c359f92dc deps: migrate to biomejs from eslint (#7108)
* Replace eslint with biomejs

* Update the inclusion of word

* Fix the formatting

* Update the lint task to do all checks

* Update biome rules from eslint config

* Replace eslint with biomejs

* Update the inclusion of word

* Fix the formatting

* Update the lint task to do all checks

* Update biome rules from eslint config

* Fix all lint issues

* Fix formatting

* Add extension recomendation for vscode

* Enable recommended rules

* Enable rule noUselessSwitchCase

* Enable rule noUselessConstructor

* Fix the types

* Fix unit tests

* Enforce import extensions

* Update the cli command

* Enforce useConsistentMemberAccessibility

* Update rules

* Fix rules

* Upgrade biomejs to latest version

* Update the rules

* Update and format the config file

* Fix types break during merge

* Fix unused check

* Add comment for explicit-return-type

* Remove eslint file

* Add _e objects for empty catch blocks

* Update formatter config

* Fix formatting
2024-10-10 12:43:36 -04:00
Nico Flaig
514b6057ea docs: fix search, redirects and broken links (#6940) 2024-07-09 22:31:35 +01:00
Julien
49c16890a9 chore: add new FAQ about yarn version (#6796)
* chore: add new FAQ about yarn version

* chore address comments

* chore: address comments

* Update CONTRIBUTING.md

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* chore: address comments

* chore: address comments

* Update docs/pages/faqs.md

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* Update docs/pages/faqs.md

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* chore: address comments

* chore: address comments

* fix: typo

---------

Co-authored-by: Nico Flaig <nflaig@protonmail.com>
2024-06-05 06:39:44 -07:00
Julien
252fd2f50a feat: add basic devcontainer support (#6667)
* feat: add basic devcontainer support

* chore: address comments
2024-04-18 06:46:06 -07:00
Julien
948de6194a chore: fix documentation CLI (#6566)
* chore: fix documentation CLI

* chore: lint md files

* chore: do not run spellcheck on generated CLI md

* chore: address comments

* chore: address comments

* chore: escape titles

* chore: generate TOC

* chore: address comments

* chore: fix lint

* Revert "chore: generate TOC"

This reverts commit 652422a848.

* chore: remove custom ids and move down header
2024-03-25 07:43:33 -07:00
Julien
490322cae8 chore: allow to serve docs from root folder (#6571)
* chore: allow to serve docs from root folder

* chore: wording

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

---------

Co-authored-by: Nico Flaig <nflaig@protonmail.com>
2024-03-21 09:36:30 -07:00
Julien
556e5eca2d chore: update the website docs (#6565) 2024-03-20 00:24:02 -07:00
Julien
40b8924f23 chore: improve missing docker engine detection (#6495)
* chore: detect when docker is not installed

* chore: improve e2e tests requirement
2024-02-28 12:37:59 +01:00
Harikrishnan Shaji
06210efab5 chore: update yarn links to point to classic yarn (#6477) 2024-02-24 16:01:36 +01:00
Nazar Hussain
da0bcc8f19 test: support .env.test to reuse env variables across the tests (#6408)
* Variables using .env file

* Add env variable support to normal tests

* Fix the order of variables

* Update the order of jobs

* Export the varible using actions toolkit

* Update the workflow tasks

* Fix the sim workflow

* Add .env.test file support to tests

* Fix the lint

* Update the task description

* Move lodestar preset to env file

* Fix the directory path

* newline

* Update debugging spec tests section

* Update the env variable for preset

* Fix the path for setup files

* Update code as per feedback

* Fix the e2e variables

* Update doc

* Fix the bash script

* Fix sim geth runne

* Update the env file

* Fix e2e tests

* Update the script tasks

* Update the script tasks

* Add minimal for e2e tests

* Add minimal for e2e tests

* Update comments in preset tests

* Downgrade nethermind version

* Load env file in e2e env

* Add the issue link in env variable

* Update bash script for failsafe current dir

* Fix the mistaken genesis extension for el nodes

* Add missing capella wait for one test

* Downgrade the geth version

* Update .env.test

---------

Co-authored-by: Nico Flaig <nflaig@protonmail.com>
2024-02-12 14:36:33 +01:00
Julien
8e0078b828 docs: reflect vitest migration (#6247)
* fix: reflect vitest migration

* fix:  incorrect spec example folder

* chore: added filter examples

---------

Co-authored-by: Cayman <caymannava@gmail.com>
2024-01-30 17:54:37 -05:00
Julien
ed43a988bf chore: align vitest config filenames (#6369) 2024-01-29 12:53:35 -05:00
Julien
01d47b9a09 chore: align test scripts (#6339)
* chore: align yarn test scripts

* fix: handle prover stratup failure

* fix: lint

* chore: improve test guide

* chore: introduce top level download-spec-tests script

* chore: remove pretest scripts
2024-01-25 11:00:48 +01:00
Nazar Hussain
5b129f0f00 chore: cleanup mocha/chai/sinon usage across the repo (#6311)
* Cleanup mocha/chai usage

* Split the config files for each package

* Fix types

* Fix lint errors

* Sort the lint rules

* Fix types

* Cleanup sinon usage

* Fix tests

* Fix lint error

* Add vitest word to dictionary

* Fix the test iteration

* Fix e2e tests

* Sort the words

* Fix sim test assertion

* Fix data import

* Fix import order for mocks

* Fix import order

* Fix e2e tests

* Add contribution guide

* Fix the lint error

* Add src to dictionary

* Remove eslint-disable for skipped tests

* Fix assertions

* Update CONTRIBUTING.md

Co-authored-by: Matthew Keil <me@matthewkeil.com>

---------

Co-authored-by: Matthew Keil <me@matthewkeil.com>
2024-01-22 18:35:20 +01:00
Phil Ngo
551fd8e455 docs: add documentation contribution instructions (#6294)
* add documentation contribution instructions

* docs contribution to include cmd and wordlist

* spell check documentation

* add wordlist check script

* word list correction

* incorporate feedback
2024-01-17 20:38:10 -05:00
Julien
5270ef2346 docs: improve prerequisites for OSX users (#6157)
* chore: added extra error logs when gdu is not installed

* chore: improves prerequisites for osx

* chore: fixed spelling

* chore: update list symbol

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* chore: update quote type

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* chore: fix lint issue

* chore: added extra words to wordlist

* chore: fixed wordlist order

* chore: fix wording

Co-authored-by: Matthew Keil <me@matthewkeil.com>

* chore: fix wording

Co-authored-by: Matthew Keil <me@matthewkeil.com>

* fix: revert linking to CONTRIBUTING for prerequisites

---------

Co-authored-by: Nico Flaig <nflaig@protonmail.com>
Co-authored-by: Matthew Keil <me@matthewkeil.com>
2023-12-07 15:24:27 +00:00
Nico Flaig
c50db8f7ae docs: add section about metrics to style guide (#6048) 2023-10-19 04:09:06 -04:00
Nico Flaig
7438c265a8 docs: update instructions on how to contribute to dashboards (#5832)
* docs: update instructions on how to contribute to dashboards

* Add UID to spell check word list
2023-08-01 09:39:23 -04:00
Lion - dapplion
9e57b7d320 ci: check docs spelling (#5527)
* Check docs spelling

* Add config

* Fix docs spelling

* Lint docs format

* docs(flamegraph): remove note about script that was removed

* sort wordlist

* Set sort algo

* Fix CI pipeline

* hope to fix CI ordering

* Disable wordlist sort check

* docs(CONTRIBUTING): remove merge conflict marker and add codeblock types

* refactor: change to pyspelling.yml for local runs

* docs: make spell-checking wordlist case insensitive

* fix: sort .wordlist.txt

* refactor: alphabetize script order

* fix: add docs/reference to gitignore

* docs: add codeblocks to pyspelling ignore and clear all errors

* docs: ignore possessive endings in spellcheck

* docs: clear spelling errors in package readmes

* docs: pyspelling fix generated cli.md

* feat(workflows): lint generated docs

* feat(workflows): add word sort to docs-check

* test: unsort wordlist

* fix: sort wordlist

* refactor(workflow): remove unused comments

---------

Co-authored-by: matthewkeil <me@matthewkeil.com>
Co-authored-by: Cayman <caymannava@gmail.com>
2023-06-21 18:24:27 +00:00
Nico Flaig
83d1b7c81e chore: replace lerna commands with yarn (#5657)
* Remove lerna from prerequisites

* Replace lerna commands with yarn
2023-06-16 10:58:27 -04:00
Nico Flaig
083375777a docs: update instructions on how to contribute to dashboards (#5581)
* Update instructions on how to contribute to dashboards

* Dashboard must be saved before downloading
2023-05-30 10:26:01 -04:00
Lion - dapplion
b5ab113326 chore: add test style guide for assert messages (#5528)
Add test style guide for assert messages
2023-05-24 05:17:54 -04:00
Lion - dapplion
28efaea30e chore: add note in CONTRIBUTING about external test deps (#5471)
* Add note in CONTRIBUTING about external test deps

* Update CONTRIBUTING.md

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

---------

Co-authored-by: Nico Flaig <nflaig@protonmail.com>
2023-05-08 10:00:07 -04:00
Nico Flaig
b60b43c1eb docs: fix formatting of examples in PR naming section (#5431) 2023-04-28 23:16:33 +02:00
Phil Ngo
1d7b238c4b docs: update contribution.md for conventional commits (#5419)
* docs: Update contribution.md for conventional commits

* Remove capitalization requirement

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* Redo examples of conventional commits

---------

Co-authored-by: Nico Flaig <nflaig@protonmail.com>
2023-04-27 16:16:12 -04:00
Nico Flaig
3ee1d8a5ac Remove outdated logging framework in style guide (#5370)
Replaced by "Logging policy" section added in https://github.com/ChainSafe/lodestar/pull/5299
2023-04-17 17:01:10 -04:00
Lion - dapplion
ddc58cebfc Add logging policy (#5299)
* Add logging policy

* Update CONTRIBUTING.md

Co-authored-by: Cayman <caymannava@gmail.com>

* Review PR

* Address review

* review PR

---------

Co-authored-by: Cayman <caymannava@gmail.com>
2023-04-06 10:24:59 +09:00
Lion - dapplion
d1cddb7ca8 Add dockerized metrics local setup (#5173)
* Add dockerized metrics local setup

* Review PR
2023-02-20 11:08:46 -05:00
Pranay Singh
c152fe7ec0 Improve dev installation instructions (#5091)
* Add windows guide

* Apply suggestions from code review

---------

Co-authored-by: Cayman <caymannava@gmail.com>
2023-02-10 17:29:08 -05:00
Pranay Singh
f244bc872e Sentence correction in contributing.md file (#5096)
* Sentence correction

* Update CONTRIBUTING.md

---------

Co-authored-by: Cayman <caymannava@gmail.com>
2023-02-08 04:48:01 +00:00
omahs
492f436385 Fix: typos (#4978)
* Fix: typos

Fix: typos

* Fix: typos

Fix: typos
2023-01-05 09:24:37 -05:00
Cayman
7d662d7951 Use node 18 (#4779)
* Use node 18

* Add bigger timeouts

* Add uint8array concat benchmark

* increase timeouts

* Debug e2e tests

* Fix e2e tests, remove debug logs

* "fix" types

* "fix" types
2022-12-12 10:05:55 -05:00
Lion - dapplion
337f2fc86c Fix CONTRIBUTING.md spec tests instructions (#4840)
* Fix CONTRIBUTING.md spec tests instructions

* Add lint instructions
2022-12-05 13:42:37 -05:00
Phil Ngo
d84e1d970f Contributing.md doc Update (#4289)
Update contributing.md doc
2022-07-13 09:18:54 +00:00
Cayman
e5dabac124 Rename packages using @lodestar namespace (#4231)
* Remove event handlers file

* exposing util module from the light-client package

* Rename packages using @lodestar namespace

* Fix linter errors

* Fix merge

Co-authored-by: dapplion <35266934+dapplion@users.noreply.github.com>
Co-authored-by: Dadepo Aderemi <dadepo@gmail.com>
2022-07-06 12:30:36 -05:00
Lion - dapplion
510f3108e4 Adopt gitflow for Lodestar releases (#4071)
* Adopt gitflow for Lodestar releases

* Apply feedback

* Replace most mentions of `master` with `unstable`

* Tweak various parts of RELEASE.md

* Update CI

* Tweak dev release version handling

* Tweak workflow names

* Replace `nightly` with `dev`

* Replace `beta` with `rc`

* Fix publish for rc release and stable release only

* Remove stray "beta"

* Add code examples to RELEASE.md

* Clarify publish process

* Collapse 'Alternatives considered' section

* Move 'Details' header up one level

* Clarify publishing a release

* Tweak headings

* Fix hotfix section

* More clarifications

* Update examples in RELEASE.md

* More clarifications

* Fix formatting

* Run RELEASE.md through grammarly

* Change script name to release:publish

* Add create_rc script

* Add workflow_dispatch for create RC

* Add placeholder for other scripts

* Update RELEASE.md

* Update release create rc script

* Update script instructions

* create_rc script must not be run in CI

* Update release flow

* Add publish-rc workflow

* Apply suggestions from code review

Co-authored-by: Afr Schoe <58883403+q9f@users.noreply.github.com>

Co-authored-by: Cayman <caymannava@gmail.com>
Co-authored-by: Afr Schoe <58883403+q9f@users.noreply.github.com>
2022-05-30 10:22:00 -05:00
Lion - dapplion
1f3bb75147 Split Gossipsub rows into its own dashboard (#3918)
* Add contributing guide for dashboards

* Split debug gossipsub metrics into separate dashboard
2022-04-13 14:58:57 +02:00
Phil Ngo
6bd0310a96 Removing eth2 mentions in documentation and fix links (#3848)
* Remove architecture.md from docs

* Update mkdocs.yml to remove architecture.md

* Remove architecture link from readme

* Remove architecture.md links from depgraph.md

* Remove architecture overview from readme

* Remove eth2 terminology on contributing.md

* remove eth2 references from docs
2022-03-13 17:31:26 -05:00
Lion - dapplion
9a58ce3c8b Run prettier on entire repo (#3720) 2022-02-07 09:57:26 -06:00
Lion - dapplion
f9c7432215 Add guide on how to debug tests (#3719) 2022-02-07 09:56:56 -06:00
Lion - dapplion
8c3a4181c3 Add Github style guide to CONTRIBUTING.md (#3630) 2022-01-17 17:52:20 +01:00
Cayman
e3662e6b4b Update docs to reference node 16 - Gallium (#3450) 2021-11-22 09:16:28 +07:00
Afr Schoe
796e56dbdd github: update bot labels (#3135)
* github: update labeler labels to match new

* github: fix stale bot labels

* github: use srvaroa/labeler@v0.8

* github: fix labeler credentials

* github: lint label yaml

* github: improve labeler readability

* github: use go regex for labeler

* github: update bulldozer to latest config

* github: update changelog exclude label

* github: update bulldozer conditions

* github: add dependabot config

* docs: describe labels for contributors
2021-09-14 18:40:37 +02:00
Afr Schoe
b37a42580f docs: revamp readme, security, and contributing (#3128)
* docs: update readme

* docs: update security

* docs: update readme

* docs: update contributing

* docs: update contributing

* docs: update security

* docs: add new packages to readme
2021-09-14 09:16:09 +02:00