Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (58 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

81 lines (58 loc) · 1.96 KB

Contributing Guidelines

Thank you for your interest in contributing to our project! This document provides guidelines and steps for contributing.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

1. Reporting Bugs

  • Use the issue tracker to report bugs
  • Include a detailed description of the bug
  • Provide steps to reproduce the issue
  • Include your environment details (OS, Python/Node.js version, etc.)
  • If possible, include a minimal code example that reproduces the issue

2. Suggesting Enhancements

  • Use the issue tracker to suggest new features
  • Clearly describe the feature and its benefits
  • Provide examples of how the feature would be used
  • If possible, include mock-ups or diagrams

3. Pull Requests

  1. Fork the repository
  2. Create a new branch for your feature/fix
  3. Make your changes
  4. Run tests and ensure they pass
  5. Update documentation if necessary
  6. Submit a pull request

Code Style

  • Follow PEP 8 for Python projects
  • Follow ESLint rules for JavaScript/TypeScript projects
  • Write clear, descriptive commit messages
  • Include tests for new features
  • Update documentation as needed

Commit Message Format

<type>(<scope>): <subject>

<body>

<footer>

Types:

  • feat: new feature
  • fix: bug fix
  • docs: documentation changes
  • style: formatting, missing semi-colons, etc.
  • refactor: code refactoring
  • test: adding tests
  • chore: maintenance

Review Process

  1. Pull requests will be reviewed by maintainers
  2. Feedback will be provided if changes are needed
  3. Once approved, your changes will be merged

Development Setup

  1. Clone the repository
  2. Install dependencies
  3. Run tests
  4. Make your changes
  5. Submit a pull request

Questions?

If you have any questions, feel free to:

  • Open an issue
  • Contact the maintainers
  • Join our community chat