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

[Sweep Rules] Fix broken code quality and TypeScript style rules #2383

Closed
wants to merge 1 commit into from

Conversation

sweep-ai[bot]
Copy link
Contributor

@sweep-ai sweep-ai bot commented Oct 29, 2023

PR Feedback (click)

  • 👍 Sweep Did Well
  • 👎 Sweep Needs Improvement

I created this PR to address this rule:

"Avoid using unnecessary separators or extra characters in code."

Description

This PR addresses the broken code quality and TypeScript style rules in the repository. The changes include updates to the CONTRIBUTING.md file to align with the desired code quality and TypeScript style guidelines. Additionally, the Processing-Confidence-Intervals.md file is modified to fix a code issue related to calculating the standard deviation.

Summary of Changes

  • Updated code quality guidelines in CONTRIBUTING.md to aim for at least 8/10 quality in /packages/squiggle-lang and 7/10 quality in /packages/components.
  • Updated TypeScript style guidelines in CONTRIBUTING.md to prefer const over let and never use var.
  • Updated functional style guidelines in CONTRIBUTING.md to use functional style and avoid classes whenever possible.
  • Updated object type guidelines in CONTRIBUTING.md to wrap object types in Readonly or mark individual fields as readonly.
  • Updated namespace guidelines in CONTRIBUTING.md to use native ES modules instead of namespaces.
  • Updated any usage guidelines in CONTRIBUTING.md to avoid using any as much as possible.
  • Updated equality comparison guidelines in CONTRIBUTING.md to always use === instead of ==.
  • Updated external library usage guidelines in CONTRIBUTING.md to avoid using too many external libraries, especially in squiggle-lang.
  • Updated named exports guidelines in CONTRIBUTING.md to prefer named exports over default exports for easier refactorings.
  • Updated file naming and organization guidelines in CONTRIBUTING.md to name files according to their main named exports and split code into many small files.
  • Fixed code issue in Processing-Confidence-Intervals.md by updating the calculation of the standard deviation.

Please review and merge these changes to ensure adherence to the desired code quality and TypeScript style guidelines.

@sweep-ai sweep-ai bot requested review from OAGr and berekuk as code owners October 29, 2023 21:39
@sweep-ai
Copy link
Contributor Author

sweep-ai bot commented Oct 29, 2023

Rollback Files For Sweep

  • Rollback changes to CONTRIBUTING.md

@sweep-ai sweep-ai bot assigned OAGr Oct 29, 2023
@sweep-ai sweep-ai bot added the sweep label Oct 29, 2023
@sweep-ai
Copy link
Contributor Author

sweep-ai bot commented Oct 29, 2023

Sandbox Executions

  • Check CONTRIBUTING.md
Run CONTRIBUTING.md through the sandbox.
  • Check packages/website/src/pages/docs/Internal/Processing-Confidence-Intervals.md
Run packages/website/src/pages/docs/Internal/Processing-Confidence-Intervals.md through the sandbox.

@changeset-bot
Copy link

changeset-bot bot commented Oct 29, 2023

⚠️ No Changeset found

Latest commit: b84d47c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@sweep-ai sweep-ai bot temporarily deployed to Preview October 29, 2023 21:39 Inactive
@vercel
Copy link

vercel bot commented Oct 29, 2023

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

Name Status Preview Updated (UTC)
quri-hub ✅ Ready (Inspect) Visit Preview Oct 29, 2023 9:42pm
quri-ui ✅ Ready (Inspect) Visit Preview Oct 29, 2023 9:42pm
squiggle-components ✅ Ready (Inspect) Visit Preview Oct 29, 2023 9:42pm
squiggle-website ✅ Ready (Inspect) Visit Preview Oct 29, 2023 9:42pm

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

Successfully merging this pull request may close these issues.

1 participant