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.

Sign up for GitHub

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

Coderabbit/config updates #35645

Merged
merged 7 commits into from
Jan 22, 2025
+22 −10
Merged

Coderabbit/config updates #35645

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
99fe884
Disable draft reviews
Charl1996 Jan 21, 2025
58b516a
Add some instructions
Charl1996 Jan 21, 2025
c5ddabb
Remove walkthrough
Charl1996 Jan 21, 2025
282c803
Add path filters to only review certain types of files
Charl1996 Jan 21, 2025
be675dd
Be more explicit in config
Charl1996 Jan 21, 2025
c5c1dc5
Add HTML to path_filters
Charl1996 Jan 22, 2025
b2aa9d3
Add link to google js guide
Charl1996 Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .coderabbit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ reviews:
path_instructions:
- path: "**/*.js"
instructions: >-
- Review the JavaScript code against the Google JavaScript style guide and point out any mismatches
- Review the JavaScript code against the [Google JavaScript style guide](https://google.github.io/styleguide/jsguide.html) and point out any mismatches
Copy link
Contributor Author

Choose a reason for hiding this comment

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

There's a note on the site saying

Please note: This guide is no longer being updated. Google recommends migrating to TypeScript, and following the TypeScript guide.

Do we rather want to include that?

Copy link
Contributor

Choose a reason for hiding this comment

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

We do not use TypeScript, so that doesn't seem right. I think this is fine for now. We may want to investigate other options for JS guides that are maintained.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Figured as much. The "Google JavaScript style guide" I got from examples of what other people online use and I figured that it sounds OK, but definitely open to investigate this further.

- Also follow [this guide](https://github.com/dimagi/commcare-hq/blob/master/docs/js-guide/code-review.rst)
- path: "**/*.py"
instructions: >-
Expand Down
Loading