Skip to content

unify dev stuff under contrib#478

Merged
ngundotra merged 2 commits intomasterfrom
contrib
Mar 4, 2025
Merged

unify dev stuff under contrib#478
ngundotra merged 2 commits intomasterfrom
contrib

Conversation

@ngundotra
Copy link
Copy Markdown
Contributor

@ngundotra ngundotra commented Mar 4, 2025

Description

Update contributions.md & readme.md


Important

Update CONTRIBUTING.md and README.md to improve contribution guidelines and development setup instructions.

  • CONTRIBUTING.md:
    • Added note about not accepting PRs for wallet adapter functionality.
    • Updated development environment setup instructions, including pnpm version requirement and troubleshooting steps.
    • Removed redundant PR description template and code style section.
  • README.md:
    • Revised contributing section to reference CONTRIBUTING.md for detailed guidelines.
    • Added instructions for creating issues and reporting security vulnerabilities.

This description was created by Ellipsis for ac9e4eb. It will automatically update as commits are pushed.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 4, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
explorer ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 4, 2025 9:32pm

Copy link
Copy Markdown
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❌ Changes requested. Reviewed everything up to ac9e4eb in 1 minute and 57 seconds

More details
  • Looked at 179 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 7 drafted comments based on config settings.
1. CONTRIBUTING.md:163
  • Draft comment:
    The removal of the PR description template and detailed Code Style instructions might leave new contributors less guided. Ensure that alternative or consolidated guidelines are documented elsewhere.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
2. README.md:9
  • Draft comment:
    The updated 'Contributing' section is concise; ensure that detailed dev instructions (e.g. environment setup and dependency guidelines) remain easily accessible, possibly by cross-linking the CONTRIBUTING.md.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is asking the PR author to ensure that documentation is accessible, which is not allowed by the rules. It does not provide a specific code suggestion or point out a specific issue with the code.
3. CONTRIBUTING.md:23
  • Draft comment:
    The added 'Important Note' clearly advises contributors regarding wallet adapter functionality. Consider including a link to a policy or additional details if these guidelines are maintained elsewhere.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
4. CONTRIBUTING.md:55
  • Draft comment:
    The troubleshooting step using 'blow reset to master' is a bit informal. Consider rephrasing it (e.g., 'perform a hard reset to the master branch') to keep the documentation professional.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
5. CONTRIBUTING.md:163
  • Draft comment:
    The removal of the PR Description Template and Code Style sections reduces redundancy, but these guidelines help maintain consistency. If they are still relevant, consider linking to their updated location or providing a brief reference.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50%
    None
6. README.md:9
  • Draft comment:
    The 'Contributing' section in the README now succinctly directs users to the CONTRIBUTING.md guide, promoting DRY principles. This consolidation improves readability.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
7. README.md:35
  • Draft comment:
    There appears to be a subject–verb agreement issue on line 35. The sentence reads: "Any content produced by SF or developer resources that SF provides, are for educational and inspiration purposes only." Consider revising it to "...is for educational and inspirational purposes only." to improve clarity and grammatical correctness.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.

Workflow ID: wflow_i3Vto7COO31gkWHp


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ngundotra and others added 2 commits March 4, 2025 16:30
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
@ngundotra ngundotra merged commit 638c967 into master Mar 4, 2025
3 checks passed
@ngundotra ngundotra deleted the contrib branch March 4, 2025 21:33
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.

1 participant