Skip to content

updating contributor guidelines#6787

Open
robertolopezlopez wants to merge 1 commit into
mainfrom
fix/contributing
Open

updating contributor guidelines#6787
robertolopezlopez wants to merge 1 commit into
mainfrom
fix/contributing

Conversation

@robertolopezlopez
Copy link
Copy Markdown

@robertolopezlopez robertolopezlopez commented May 8, 2026

Pull Request Submission Checklist

  • Follows CONTRIBUTING guidelines
  • Commit messages
    are release-note ready, emphasizing
    what was changed, not how.
  • Includes detailed description of changes
  • Contains risk assessment (Low | Medium | High)
  • Highlights breaking API changes (if applicable)
  • Links to automated tests covering new functionality
  • Includes manual testing instructions (if necessary)
  • Updates relevant GitBook documentation (PR link: ___)
  • Includes product update to be announced in the next stable release notes

What does this PR do?

Minor chores:

  • fixing a minor error in the contribution guidelines

Where should the reviewer start?

How should this be manually tested?

bash ./scripts/install-dev-dependencies.sh

What's the product update that needs to be communicated to CLI users?

No product update: it just affects developer documentation and scripts.

Risk assessment (Low | Medium | High)?

Low

@robertolopezlopez robertolopezlopez requested review from a team as code owners May 8, 2026 12:13
@snyk-io
Copy link
Copy Markdown

snyk-io Bot commented May 8, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@snyk-pr-review-bot

This comment has been minimized.

@snyk-pr-review-bot

This comment has been minimized.

@robertolopezlopez robertolopezlopez changed the title Fix/contributing updating contributor guidelines and development dependencies May 8, 2026
@snyk-pr-review-bot

This comment has been minimized.

CONTRIBUTING told contributors to \`cd snyk\` after cloning, but the clone creates a \`cli\` directory.
@robertolopezlopez robertolopezlopez changed the title updating contributor guidelines and development dependencies updating contributor guidelines May 8, 2026
@snyk-pr-review-bot
Copy link
Copy Markdown

PR Reviewer Guide 🔍

🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Incomplete PR 🟠 [major]

The PR description and title state that Node.js is being added to the Brewfile, yet the Brewfile is missing from the diff. This makes the PR incomplete and prevents the 'install-dev-dependencies.sh' script from working as intended for new contributors.

cd cli
Non-Canonical Name 🟡 [minor]

The change to cd cli aligns with the alias URL on the preceding line but contradicts the canonical repository name snyk found in package.json. If a user clones using the canonical URL, this command will fail. Additionally, the clone command on line 20 is malformed as it uses a slash instead of a colon. It is recommended to fix the URL to git@github.com:snyk/snyk.git and use cd snyk.

cd cli
📚 Repository Context Analyzed

This review considered 7 relevant code sections from 5 files (average relevance: 0.50)

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