ultimate-artist/samplerule icon
public
Published on 3/26/2025
ultimate-artist/samplerule

Rules

Build & Development Commands

  • Use npm or yarn for dependency management and script execution. - Ensure compatibility with modern JavaScript (ES6+). - Use environment variables (.env) for configuration instead of hardcoding values. - Follow module-based architecture and avoid unnecessary dependencies.

Testing Guidelines

  • Use Jest or Mocha for unit testing. - Maintain high test coverage with meaningful test cases. - Follow the Arrange-Act-Assert pattern in test cases. - Use mocks and stubs where necessary to isolate test behavior.

Code Style & Guidelines

  • Follow ESLint with a recommended or project-specific configuration. - Use Prettier for consistent code formatting. - Prefer const and let over var. - Use meaningful variable and function names. - Keep functions pure and reusable where possible. - Write modular and maintainable code, avoiding large monolithic files.

Documentation Guidelines

  • Use JSDoc for documenting functions, classes, and modules. - Clearly describe function parameters, return types, and expected behavior. - Maintain an up-to-date README.md with project setup, usage, and examples. - Document API endpoints using OpenAPI/Swagger if applicable.