Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (17 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 1.07 KB
Raw

Contributing to HackJS

Thank you for your interest in contributing to HackJS! We welcome contributions of all kinds, from bug fixes to new features and documentation improvements.

How to Contribute

  1. Fork the Repository: Create a fork of this repository on GitHub.
  2. Clone the Repository: Clone your fork to your local machine.
  3. Create a Branch: Create a new branch for your changes (git checkout -b feature/[FEATURE_NAME]).
  4. Make Changes: Implement your changes and ensure they follow the project's coding standards.
  5. Run Tests: Ensure all tests pass (bun typecheck and bun lint).
  6. Commit Changes: Commit your changes with clear and descriptive commit messages.
  7. Push Changes: Push your changes to your fork on GitHub.
  8. Submit a Pull Request: Submit a pull request to the main repository.

Coding Standards

  • We use Biome for linting and formatting.
  • Ensure your code is well-documented and follows TypeScript best practices.
  • Add unit tests for new features where possible.

Thank you for your contributions!