Skip to content

Conversation

@GauravBurande
Copy link
Contributor

@GauravBurande GauravBurande commented Dec 1, 2025

closes: #647

Description

added contributing guidelines for:

  • use the biome extension for formatting
  • set ur default formatter to biome in the workspace settings
  • make sure to use bun version as mentioned in the configs
  • build scripts like bun run build --filter=web

Important

Updates contributing guidelines to include build step and prerequisites for Bun and Biome.

  • Prerequisites:
    • Added requirement for specific Bun version as per package.json or .bun-version.
    • Introduced Biome for code formatting and linting, advising to disable other formatters.
    • Instructions to install Biome VS Code extension and set it as default formatter in .vscode/settings.json.
  • Build Step:
    • Added build step using bun run build --filter=web before committing changes.

This description was created by Ellipsis for 4e8a6e4. You can customize this summary. It will automatically update as commits are pushed.

Copy link

@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.

Important

Looks good to me! 👍

Reviewed everything up to 4e8a6e4 in 2 minutes and 3 seconds. Click for details.
  • Reviewed 57 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. CONTRIBUTING.md:11
  • Draft comment:
    Good addition of the 'Build Your Changes' step. Consider clarifying if 'bun run build --filter=web' applies solely to web builds or if there are alternate commands for other parts of the project.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None
2. CONTRIBUTING.md:52
  • Draft comment:
    The JSON snippet for setting the default formatter includes an inline comment ('// optional'), which is not valid JSON. Consider removing it to prevent potential copy‐paste issues.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 35% vs. threshold = 50% This is a valid technical issue - JSON does not support comments, and if someone copies this snippet directly into their .vscode/settings.json file, it could cause parsing errors depending on the JSON parser used. VS Code's settings.json actually supports JSONC (JSON with Comments), so it might work in practice, but it's still technically incorrect JSON and could confuse contributors or cause issues in stricter parsers. The comment is about changed code (the JSON snippet was added in this PR), suggests a clear action (remove the inline comment), and identifies a legitimate potential problem. This is not speculative - it's a factual statement that the JSON is invalid. The comment is actionable and clear. VS Code actually uses JSONC (JSON with Comments) for its settings files, so the inline comment would likely work fine in practice. The comment might be overly pedantic since contributors would be copying this into a VS Code settings file where comments are supported. Additionally, the inline comment provides useful context that the setting is optional. While VS Code does support comments in settings.json, the code block is explicitly labeled as json (not jsonc), which sets the expectation of valid JSON. Contributors might copy this to other contexts, or it could confuse people about JSON syntax. The comment is technically correct and actionable. However, the useful context provided by "// optional" would be lost. A better solution might be to move the comment outside the JSON block or use a different approach to indicate optionality. The comment identifies a technically valid issue (invalid JSON syntax) in newly added code and provides an actionable suggestion. However, it's somewhat pedantic given that VS Code supports comments in settings.json, and removing the comment loses useful context. This is a borderline case - the comment is correct but the issue is minor.

Workflow ID: wflow_LkyZD6a4q9ZQRowG

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

Copy link
Contributor

@tobeycodes tobeycodes left a comment

Choose a reason for hiding this comment

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

Happy this is merged once the requested changes are made. But I do think we should try to trim down this document to the essentials and take inspiration from other popular open source projects.

@GauravBurande GauravBurande force-pushed the grv/contributing-prereqs branch 4 times, most recently from ce9ac02 to 764f394 Compare December 2, 2025 04:44
@GauravBurande GauravBurande requested a review from beeman December 2, 2025 08:25
@GauravBurande GauravBurande force-pushed the grv/contributing-prereqs branch from 764f394 to 7a3007e Compare December 2, 2025 08:26
@beeman beeman merged commit aeea92a into samui-build:main Dec 2, 2025
10 checks passed
@beeman
Copy link
Contributor

beeman commented Dec 2, 2025

Thanks @GauravBurande

@GauravBurande GauravBurande deleted the grv/contributing-prereqs branch December 2, 2025 08:38
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.

contributing guidelines to prevent formatting and build issues

3 participants