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(contribution-guidelines): update Nx version #72

Merged
merged 2 commits into from
Aug 26, 2024

Conversation

JeremyFriesenGitHub
Copy link
Contributor

@JeremyFriesenGitHub JeremyFriesenGitHub commented Aug 25, 2024

  • Nx contained different versions (latest: 19.6.2 in contrast to 19.5.7), which were conflicting each other when cloning the repo. Fixed the docs to make sure to download the specific 19.5.7 version instead of the latest version
  • Made VSCode recognize the TypeScript version to use

Summary by Sourcery

Update the contribution guidelines to specify a fixed Nx version for installation, ensuring consistency in the development environment.

Documentation:

  • Update the contribution guidelines to specify the installation of Nx version 19.5.7 instead of the latest version.

Copy link

sourcery-ai bot commented Aug 25, 2024

Reviewer's Guide by Sourcery

This pull request updates the Nx version specified in the contribution guidelines documentation. The change ensures consistency in the Nx version used across the project.

File-Level Changes

Change Details Files
Update Nx version in installation instructions
  • Change Nx installation command from 'nx@latest' to '[email protected]'
  • Specify a fixed version (19.5.7) instead of using the latest version
apps/docs/src/content/docs/contribution-guidelines/index.mdx

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

netlify bot commented Aug 25, 2024

Deploy Preview for cuhacking-docs failed.

Name Link
🔨 Latest commit baf0711
🔍 Latest deploy log https://app.netlify.com/sites/cuhacking-docs/deploys/66cb755cd9559000082e1417

Copy link

netlify bot commented Aug 25, 2024

Deploy Preview for cuhacking-portal-dev failed. Why did it fail? →

Name Link
🔨 Latest commit baf0711
🔍 Latest deploy log https://app.netlify.com/sites/cuhacking-portal-dev/deploys/66cb755c08104d0008c2fe16

@JeremyFriesenGitHub JeremyFriesenGitHub added the documentation Improvements or additions to documentation label Aug 25, 2024
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @JeremyFriesenGitHub - I've reviewed your changes - here's some feedback:

Overall Comments:

  • There's a discrepancy between the PR description, which mentions updating to version 19.6.2, and the actual change in the diff, which shows version 19.5.7. Could you clarify which version is intended and update either the PR description or the code accordingly?
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

@MFarabi619
Copy link
Member

Optional: Specify commit message scopes.

So instead of docs: ...., docs(contribution-guidelines): .....
Instead of chore:...., chore(config/vscode): ....

@JeremyFriesenGitHub JeremyFriesenGitHub merged commit 89ee8e9 into main Aug 26, 2024
2 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants