Skip to content

Conversation

@Uginchus
Copy link

@Uginchus Uginchus commented Nov 8, 2025

Important considerations when opening a pull request:

  1. Make sure you do not make the changes you want to open a pull request for on the master branch of your fork, or open the pull request from the master branch of your fork. Some of our integrations will fail if you do this, resulting in your pull request not being accepted. If this is your first pull request, it is probably a good idea to first read up on how opening pull requests work (https://opensource.com/article/19/7/create-pull-request-github is a good introduction);

  2. Pull requests will only be accepted if they are opened against the master branch of our repository. Pull requests opened against other branches without prior consent from the maintainers will be closed;

  3. Please follow the coding style guidelines: https://betaflight.com/docs/development/CodingStyle

  4. Keep your pull requests as small and concise as possible. One pull request should only ever add / update one feature. If the change that you are proposing has a wider scope, consider splitting it over multiple pull requests. In particular, pull requests that combine changes to features and one or more new targets are not acceptable.

  5. Ideally, a pull request should contain only one commit, with a descriptive message. If your changes use more than one commit, rebase / squash them into one commit before submitting a pull request. If you need to amend your pull request, make sure that the additional commit has a descriptive message, or - even better - use git commit --amend to amend your original commit.

  6. All pull requests are reviewed. Be ready to receive constructive criticism, and to learn and improve your coding style. Also, be ready to clarify anything that isn't already sufficiently explained in the code and text of the pull request, and to defend your ideas.

  7. We use continuous integration (CI) with GitHub Actions to build all targets and run the test suite for every pull request. Pull requests that fail any of the builds or fail tests will most likely not be reviewed before they are fixed to build successfully and pass the tests. In order to get a quick idea if there are things that need fixing before opening a pull request or pushing an update into an existing pull request, run yarn lint to verify formatting and yarn run vitest run to execute the test suite. Note: This is not an exhaustive test, so even if this passes the CI build might still fail.

  8. If your pull request is a fix for one or more issues that are open in GitHub, add a comment to your pull request, and add the issue numbers of the issues that are fixed in the form Fixes #<issue number>. This will cause the issues to be closed when the pull request is merged;

  9. Remove this Text :).

Summary by CodeRabbit

  • Documentation

    • Added setup and run instructions for development and production environments.
  • Chores

    • Updated Node.js engine requirement.
    • Upgraded core libraries and development tooling.
    • Removed pre-commit hook configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 8, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation expanded in README with "How to" section covering environment setup and PWA instructions. package.json updated with repository URL change to fork, Node engine bumped to 22.x, Three.js upgraded from ~0.97.0 to ^0.171.0, Vue tooling updated, new dependencies added ("20", "express"), and Husky pre-commit hook configuration removed.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added "How to" section with environment preparation, PWA development/production instructions, build-and-preview option, and Betaflight setup examples
Build & Dependencies
package.json
Updated repository URL to fork (Uginchus/BetaflightConfigurator), bumped Node engine to 22.x, upgraded Three.js to ^0.171.0, updated Storybook and Vue tooling, added "20" and "express" dependencies, added nodemon to devDependencies, removed Husky pre-commit configuration

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

  • Three.js major version bump (~0.97.0 → ^0.171.0): Significant version leap requiring verification of API compatibility and potential breaking changes in graphics/3D rendering code
  • Vue ecosystem updates: Multiple coordinated dependency version changes ("vue-loader", "@storybook/vue", "@storybook/addon-essentials") that may introduce incompatibilities or require code adjustments
  • New dependencies: Verify purpose and necessity of "20" (unusual package name) and "express" (likely for server functionality)
  • Repository fork change: Confirm intentional fork to Uginchus/BetaflightConfigurator and implications for future sync/maintenance
  • Husky removal: Verify pre-commit hooks are not required going forward and no workflow disruption expected

Suggested labels

RN: BUILD SYSTEM

Suggested reviewers

  • haslinghuis
  • SupaflyFPV

Poem

🐰 Dependencies hop and leap,
Three.js climbs a mountain steep,
Node twenty-two now takes the lead,
With express fast and "20" seed,
Docs flow smooth—how-tos we keep!

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a1b74ab and 0f9ea2a.

⛔ Files ignored due to path filters (2)
  • package-lock.json is excluded by !**/package-lock.json
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (2)
  • README.md (1 hunks)
  • package.json (3 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 8, 2025

Auto-closing pull request because the source branch is named 'master'. Please create a feature branch instead. https://betaflight.com/docs/development#using-git-and-github

@github-actions github-actions bot closed this Nov 8, 2025
@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 8, 2025

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.

1 participant