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

Update README.md #494

Merged
merged 8 commits into from
Oct 31, 2024
Merged

Update README.md #494

merged 8 commits into from
Oct 31, 2024

Conversation

leonardocustodio
Copy link
Owner

@leonardocustodio leonardocustodio commented Oct 31, 2024

PR Type

Documentation


Description

  • Updated the README to improve documentation and community engagement.
  • Added a Community section with a link to the Telegram group for developer support.
  • Introduced a Contributing section detailing ways to contribute, such as proposing features, reporting bugs, and improving documentation.
  • Acknowledged contributors and specified adherence to the all-contributors specification.

Changes walkthrough 📝

Relevant files
Documentation
README.md
Enhance README with community and contribution guidelines

README.md

  • Updated package documentation links with consistent capitalization.
  • Added new sections for Community and Contributing.
  • Included a thank you note for contributors.
  • Mentioned adherence to the all-contributors specification.
  • +29/-9   

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    codecov bot commented Oct 31, 2024

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Project coverage is 48.48%. Comparing base (ef1a4a9) to head (2718c22).
    Report is 1 commits behind head on main.

    Additional details and impacted files

    Impacted file tree graph

    @@           Coverage Diff           @@
    ##             main     #494   +/-   ##
    =======================================
      Coverage   48.48%   48.48%           
    =======================================
      Files         181      181           
      Lines        9588     9588           
    =======================================
      Hits         4649     4649           
      Misses       4939     4939           
    Flag Coverage Δ
    polkadart 15.89% <ø> (ø)
    polkadart_cli 12.04% <ø> (ø)
    polkadart_keyring 65.24% <ø> (ø)
    polkadart_scale_codec 54.93% <ø> (ø)
    secp256k1_ecdsa 89.60% <ø> (ø)
    sr25519 85.91% <ø> (ø)
    ss58 96.87% <ø> (ø)
    substrate_bip39 56.37% <ø> (ø)
    substrate_metadata 87.72% <ø> (ø)

    Flags with carried forward coverage won't be shown. Click here to find out more.

    @leonardocustodio leonardocustodio merged commit 0396bca into main Oct 31, 2024
    13 checks passed
    @leonardocustodio leonardocustodio deleted the leonardocustodio-patch-1 branch October 31, 2024 22:48
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants