-
Notifications
You must be signed in to change notification settings - Fork 0
chore: willboosterify this repo #13
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| yarn run lint | ||
| yarn run lint --quiet |
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -12,6 +12,8 @@ | |||||||||
| - Continue modifying the tests and code until all tests pass. | ||||||||||
| - Ensure tests reset any related persistent data, as our test infrastructure does not clear it automatically. | ||||||||||
| - Prefer actual API calls over mocks. Use mocks when actual calls are impractical, have unintended side effects, or are explicitly requested. | ||||||||||
| - Always investigate the root cause of a test failure before fixing it. | ||||||||||
| - Avoid adding wait functions in E2E tests unless you are confident they are necessary. | ||||||||||
| - When fixing issues, follow these rules: | ||||||||||
| - Investigate the root cause first (e.g., by gathering debug logs, taking screenshots, etc.). | ||||||||||
| - Fix the actual root cause instead of applying workarounds. | ||||||||||
|
|
@@ -22,6 +24,7 @@ | |||||||||
| - Follow the conventional commits; your commit message should start with `feat:`, `fix:`, etc. | ||||||||||
| - If not specified, make sure to add a new line at the end of your commit message with: `Co-authored-by: WillBooster (Codex CLI) <agent@willbooster.com>`. | ||||||||||
| - Always create new commits. Avoid using `--amend`. | ||||||||||
| - Always use heredoc syntax when passing multi-line content to any command. | ||||||||||
|
|
||||||||||
| ## Coding Style | ||||||||||
|
|
||||||||||
|
|
@@ -30,8 +33,10 @@ | |||||||||
| - Design each module with high cohesion, grouping related functionality together. | ||||||||||
| - Refactor existing large modules into smaller, focused modules when necessary. | ||||||||||
| - Create well-organized directory structures with low coupling and high cohesion. | ||||||||||
| - Place calling functions in the file above the functions they call to maintain a clear top-down order. | ||||||||||
| - e.g. `function caller() { callee(); } function callee() { ... }` | ||||||||||
| - Write comments that explain "why" rather than "what". Avoid stating what can be understood from the code itself. | ||||||||||
| - Place calling functions above the functions they call to maintain a clear top-down order. | ||||||||||
| - e.g., `function caller() { callee(); } function callee() { ... }` | ||||||||||
| - Unlike functions, place variable and type declarations ABOVE their usage. | ||||||||||
| - Write comments that explain "why" and use JSDoc to explain "what". | ||||||||||
| - Avoid stating what can be easily understood from the code itself. | ||||||||||
|
Comment on lines
+39
to
+40
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The proposed rule contradicts the repository style guide, which states that comments should explain "why" rather than "what". Explicitly encouraging the use of JSDoc to explain "what" may lead to redundant documentation that states the obvious, which is discouraged by the rule to avoid stating what can be understood from the code itself.
Suggested change
References
|
||||||||||
| - Prefer `undefined` over `null` unless explicitly required by APIs or libraries. | ||||||||||
| - Prefer using a single template literal for prompts instead of `join()` with an array of strings. | ||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -12,6 +12,8 @@ | |||||||||
| - Continue modifying the tests and code until all tests pass. | ||||||||||
| - Ensure tests reset any related persistent data, as our test infrastructure does not clear it automatically. | ||||||||||
| - Prefer actual API calls over mocks. Use mocks when actual calls are impractical, have unintended side effects, or are explicitly requested. | ||||||||||
| - Always investigate the root cause of a test failure before fixing it. | ||||||||||
| - Avoid adding wait functions in E2E tests unless you are confident they are necessary. | ||||||||||
| - When fixing issues, follow these rules: | ||||||||||
| - Investigate the root cause first (e.g., by gathering debug logs, taking screenshots, etc.). | ||||||||||
| - Fix the actual root cause instead of applying workarounds. | ||||||||||
|
|
@@ -22,6 +24,7 @@ | |||||||||
| - Follow the conventional commits; your commit message should start with `feat:`, `fix:`, etc. | ||||||||||
| - If not specified, make sure to add a new line at the end of your commit message with: `Co-authored-by: WillBooster (Claude Code) <agent@willbooster.com>`. | ||||||||||
| - Always create new commits. Avoid using `--amend`. | ||||||||||
| - Always use heredoc syntax when passing multi-line content to any command. | ||||||||||
|
|
||||||||||
| ## Coding Style | ||||||||||
|
|
||||||||||
|
|
@@ -30,8 +33,10 @@ | |||||||||
| - Design each module with high cohesion, grouping related functionality together. | ||||||||||
| - Refactor existing large modules into smaller, focused modules when necessary. | ||||||||||
| - Create well-organized directory structures with low coupling and high cohesion. | ||||||||||
| - Place calling functions in the file above the functions they call to maintain a clear top-down order. | ||||||||||
| - e.g. `function caller() { callee(); } function callee() { ... }` | ||||||||||
| - Write comments that explain "why" rather than "what". Avoid stating what can be understood from the code itself. | ||||||||||
| - Place calling functions above the functions they call to maintain a clear top-down order. | ||||||||||
| - e.g., `function caller() { callee(); } function callee() { ... }` | ||||||||||
| - Unlike functions, place variable and type declarations ABOVE their usage. | ||||||||||
| - Write comments that explain "why" and use JSDoc to explain "what". | ||||||||||
| - Avoid stating what can be easily understood from the code itself. | ||||||||||
|
Comment on lines
+39
to
+40
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The proposed rule contradicts the repository style guide, which states that comments should explain "why" rather than "what". Explicitly encouraging the use of JSDoc to explain "what" may lead to redundant documentation that states the obvious, which is discouraged by the rule to avoid stating what can be understood from the code itself.
Suggested change
References
|
||||||||||
| - Prefer `undefined` over `null` unless explicitly required by APIs or libraries. | ||||||||||
| - Prefer using a single template literal for prompts instead of `join()` with an array of strings. | ||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -12,6 +12,8 @@ | |||||||||
| - Continue modifying the tests and code until all tests pass. | ||||||||||
| - Ensure tests reset any related persistent data, as our test infrastructure does not clear it automatically. | ||||||||||
| - Prefer actual API calls over mocks. Use mocks when actual calls are impractical, have unintended side effects, or are explicitly requested. | ||||||||||
| - Always investigate the root cause of a test failure before fixing it. | ||||||||||
| - Avoid adding wait functions in E2E tests unless you are confident they are necessary. | ||||||||||
| - When fixing issues, follow these rules: | ||||||||||
| - Investigate the root cause first (e.g., by gathering debug logs, taking screenshots, etc.). | ||||||||||
| - Fix the actual root cause instead of applying workarounds. | ||||||||||
|
|
@@ -22,6 +24,7 @@ | |||||||||
| - Follow the conventional commits; your commit message should start with `feat:`, `fix:`, etc. | ||||||||||
| - If not specified, make sure to add a new line at the end of your commit message with: `Co-authored-by: WillBooster (Gemini CLI) <agent@willbooster.com>`. | ||||||||||
| - Always create new commits. Avoid using `--amend`. | ||||||||||
| - Always use heredoc syntax when passing multi-line content to any command. | ||||||||||
|
|
||||||||||
| ## Coding Style | ||||||||||
|
|
||||||||||
|
|
@@ -30,8 +33,10 @@ | |||||||||
| - Design each module with high cohesion, grouping related functionality together. | ||||||||||
| - Refactor existing large modules into smaller, focused modules when necessary. | ||||||||||
| - Create well-organized directory structures with low coupling and high cohesion. | ||||||||||
| - Place calling functions in the file above the functions they call to maintain a clear top-down order. | ||||||||||
| - e.g. `function caller() { callee(); } function callee() { ... }` | ||||||||||
| - Write comments that explain "why" rather than "what". Avoid stating what can be understood from the code itself. | ||||||||||
| - Place calling functions above the functions they call to maintain a clear top-down order. | ||||||||||
| - e.g., `function caller() { callee(); } function callee() { ... }` | ||||||||||
| - Unlike functions, place variable and type declarations ABOVE their usage. | ||||||||||
| - Write comments that explain "why" and use JSDoc to explain "what". | ||||||||||
| - Avoid stating what can be easily understood from the code itself. | ||||||||||
|
Comment on lines
+39
to
+40
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The proposed rule contradicts the repository style guide, which states that comments should explain "why" rather than "what". Explicitly encouraging the use of JSDoc to explain "what" may lead to redundant documentation that states the obvious, which is discouraged by the rule to avoid stating what can be understood from the code itself.
Suggested change
References
|
||||||||||
| - Prefer `undefined` over `null` unless explicitly required by APIs or libraries. | ||||||||||
| - Prefer using a single template literal for prompts instead of `join()` with an array of strings. | ||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The proposed rule contradicts the repository style guide, which states that comments should explain "why" rather than "what". Explicitly encouraging the use of JSDoc to explain "what" may lead to redundant documentation that states the obvious, which is discouraged by the rule to avoid stating what can be understood from the code itself.
References