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 and ENV Sample #49

Merged
merged 1 commit into from
Sep 16, 2024
Merged

Update Readme and ENV Sample #49

merged 1 commit into from
Sep 16, 2024

Conversation

bh2smith
Copy link
Collaborator

@bh2smith bh2smith commented Sep 16, 2024

PR Type

documentation, configuration changes


Description

  • Removed ETH_RPC environment variable from .env.sample and README.md.
  • Added instruction to provide NEAR_ACCOUNT_PRIVATE_KEY for CLI tool usage in README.md.

Changes walkthrough 📝

Relevant files
Configuration changes
.env.sample
Remove `ETH_RPC` from environment sample file                       

.env.sample

  • Removed ETH_RPC environment variable.
+0/-1     
Documentation
README.md
Update README to reflect environment variable changes       

README.md

  • Removed ETH_RPC from environment variables section.
  • Added instruction to provide NEAR_ACCOUNT_PRIVATE_KEY for CLI tool
    usage.
  • +5/-4     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @bh2smith bh2smith merged commit e590234 into main Sep 16, 2024
    1 check passed
    @bh2smith bh2smith deleted the update-readme branch September 16, 2024 12:46
    @mintbase-codium-pr-agent
    Copy link

    PR Reviewer Guide 🔍

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

    @mintbase-codium-pr-agent
    Copy link

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Security
    Mention security practices for handling private keys

    To improve the security practices, it's advisable to mention that the private key
    should be kept secret and not be committed to version control systems.

    README.md [38]

    +# IMPORTANT: Keep your private key confidential and never commit it to version control.
     NEAR_ACCOUNT_PRIVATE_KEY=
     
    Suggestion importance[1-10]: 9

    Why: Highlighting security practices for handling private keys is crucial. It helps prevent accidental exposure of sensitive information, which is a significant security concern.

    9
    Enhancement
    Add a placeholder for NEAR_ACCOUNT_ID to guide users

    Consider adding a placeholder or default value for NEAR_ACCOUNT_ID to guide users on
    what value is expected here, enhancing usability.

    .env.sample [3]

    -NEAR_ACCOUNT_ID=
    +NEAR_ACCOUNT_ID=your_account_id_here
     
    Suggestion importance[1-10]: 8

    Why: Adding a placeholder for NEAR_ACCOUNT_ID guides users on what value is expected, improving usability and reducing potential confusion.

    8
    Provide guidance on obtaining a privateKey

    It's beneficial to add a brief explanation or link to documentation on how to obtain
    or generate a privateKey for new users.

    README.md [35]

    -To use the CLI tool provided here in `examples/*` you will also need to provide a privateKey for your Near account.
    +To use the CLI tool provided here in `examples/*`, you will need to provide a privateKey for your Near account. See [Near Documentation](https://docs.near.org) on how to generate a privateKey.
     
    Suggestion importance[1-10]: 8

    Why: Providing a link to documentation on generating a privateKey is beneficial for new users. It enhances the usability of the documentation by offering clear guidance.

    8
    Add a comment explaining the purpose of NEAR_ACCOUNT_PRIVATE_KEY

    It is recommended to add a comment explaining the purpose and usage of
    NEAR_ACCOUNT_PRIVATE_KEY to enhance clarity for users who may not be familiar with
    its function.

    README.md [38]

    +# This is your Near account's private key, used for signing transactions
     NEAR_ACCOUNT_PRIVATE_KEY=
     
    Suggestion importance[1-10]: 7

    Why: Adding a comment explaining the purpose of NEAR_ACCOUNT_PRIVATE_KEY enhances clarity for users, especially those unfamiliar with the variable's function. This improves the documentation quality.

    7

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant