Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (44 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 1.68 KB

Contributing to Our Project

Thank you for your interest in contributing to our project! This document provides guidelines and instructions to help you get started.

Code of Conduct

Please review our Code of Conduct before contributing to the project.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue using the bug report template. Include as much detail as possible:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected and actual behavior
  • Screenshots if applicable
  • Environment details

Suggesting Features

Feature suggestions are welcome! Use the feature request template and provide:

  • A clear description of the feature
  • The problem it solves
  • Any implementation ideas you have

Pull Requests

  1. Fork the repository
  2. Create a new branch from main
  3. Make your changes
  4. Test your changes
  5. Submit a pull request using our pull request template

Development Setup

  1. Clone the repository
  2. Install dependencies with npm install
  3. Copy .env.local.example to .env.local and configure as needed
  4. Run the development server with npm run dev

Coding Standards

  • Follow the existing code style
  • Write tests for new features
  • Update documentation as needed

Commit Guidelines

We follow Conventional Commits:

  • feat: for new features
  • fix: for bug fixes
  • docs: for documentation changes
  • style: for formatting changes
  • refactor: for code refactoring
  • test: for tests
  • chore: for maintenance tasks

License

By contributing, you agree that your contributions will be licensed under the project's license.

Thank you for contributing!