Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.99 KB

File metadata and controls

34 lines (27 loc) · 1.99 KB

Project Information

  • Name: wbfy
  • Description: A tool for applying WillBooster's conventional configures to npm packages
  • Package Manager: yarn

General Instructions

  • Create a new branch if the current branch is main.
  • Run any git commands sequentially.
  • Write tests ONLY if explicitly requested.
    • Make sure to continue to modify the tests and code until the tests pass.
  • When fixing tests, gather debug information through logging and screenshots before modifying the code.
  • After making code changes, run yarn check-all-for-ai to execute all tests (takes up to 1 hour), or run yarn check-for-ai for type checking and linting only (takes up to 10 minutes).
    • If you are confident your changes will not break any tests, you may use check-for-ai.
  • Once you have verified your changes, commit and push them to the current (non-main) branch then create a PR via gh.
    • 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.

Coding Style

  • Simplify code as much as possible to eliminate redundancy.
  • 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.
  • When adding new functions or classes, define them below any functions or classes that call them to maintain a clear top-down call order.
  • Write comments that explain "why" rather than "what". Avoid stating what can be understood from the code itself.
  • 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.

How to Run

Use yarn start to run wbfy on this repository.