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.

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

docs: clarify running connect <> chain locally #706

Conversation

technicallyty
Copy link
Contributor

@technicallyty technicallyty commented Aug 26, 2024

adds some more clarification on running the chain for testing, or in a live env

also sneaking in the ipv6 note in here

Copy link

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (1)

initalize

These words are not needed and should be removed HEAD main

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the git@github.com:skip-mev/connect.git repository
on the tyler/con-1664-add-section-to-connect-dev-docs-that-covers-running-slinky branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/prerelease/apply.pl' |
perl - 'https://github.com/skip-mev/connect/actions/runs/10565564314/attempts/1'

OR

To have the bot accept them for you, comment in the PR quoting the following line:
@check-spelling-bot apply updates.

Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

This includes both expected items (815) from .github/actions/spelling/expect.txt and unrecognized words (1)

Dictionary Entries Covers Uniquely
cspell:python/src/python/python-lib.txt 2417 9 5
cspell:fullstack/dict/fullstack.txt 419 5 4
cspell:java/src/java.txt 2464 5 3
cspell:filetypes/filetypes.txt 264 4 3
cspell:java/src/java-terms.txt 920 4 1

Consider adding them (in .github/workflows/spell.yml) in jobs:/build: to extra_dictionaries:

          cspell:python/src/python/python-lib.txt
          cspell:fullstack/dict/fullstack.txt
          cspell:java/src/java.txt
          cspell:filetypes/filetypes.txt
          cspell:java/src/java-terms.txt

To stop checking additional dictionaries, add (in .github/workflows/spell.yml):

check_extra_dictionaries: ''
Warnings (2)

See the 📂 files view, the 📜action log, or 📝 job summary for details.

⚠️ Warnings Count
⚠️ no-newline-at-eof 3
⚠️ non-alpha-in-dictionary 3

See ⚠️ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

🚂 If you're seeing this message and your PR is from a branch that doesn't have check-spelling,
please merge to your PR's base branch to get the version configured for your repository.

@technicallyty technicallyty merged commit 26f2c7e into main Aug 26, 2024
18 checks passed
@technicallyty technicallyty deleted the tyler/con-1664-add-section-to-connect-dev-docs-that-covers-running-slinky branch August 26, 2024 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants