Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (46 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

60 lines (46 loc) · 1.53 KB
Raw

Contributing to Forca

Thank you for considering contributing to Forca! We welcome contributions of all kinds.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/forca.git
cd forca
  3. Create a branch for your changes: 
    git checkout -b feature/your-feature-name
  4. Install dependencies: 
    npm install
  5. Run the app in development mode: 
    npm run dev

Making Changes

  • Keep changes focused and atomic.
  • Follow existing code style (TypeScript, React functional components, Tailwind CSS).
  • Update or add tests where appropriate.
  • Update documentation if your change affects the user-facing API.

Commit Messages

Use conventional commits:

  • feat: add new feature
  • fix: resolve issue with X
  • docs: update README
  • refactor: restructure Y
  • chore: update dependencies

Pull Request Process

  1. Push your branch to your fork: 
    git push -u origin feature/your-feature-name
  2. Open a pull request against the main branch of 3iiik/forca.
  3. Fill out the pull request template.
  4. Ensure all CI checks pass.
  5. A maintainer will review your PR and may request changes.

Code of Conduct

Be respectful, inclusive, and constructive. Harassment and discriminatory behavior will not be tolerated.

Questions?

Open a discussion or file an issue.