Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (73 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

80 lines (73 loc) · 2.62 KB

Contributing Guidelines

Thank you for considering contributing to this project! We welcome contributions of all kinds, including bug fixes, new features, documentation improvements, and more. Please take a moment to review these guidelines before you start.

📋 How to Contribute

  1. Fork the Repository
    Create your own fork of the project to work on.
  2. Create a Branch
    Use a descriptive branch name for your work:
    git checkout -b feature/short-description
  3. Make Changes
    • Follow the coding style of the project.
    • Write clear, concise commit messages.
    • Include tests when possible.
  4. Run Tests
    Ensure that all tests pass before submitting your changes:
    npm test
    (or the relevant command for this project)
  5. Submit a Pull Request (PR)
    • Push your branch to your fork.
    • Open a PR against the main branch.
    • Clearly describe your changes in the PR description.

✅ Code Style

  • Use consistent formatting as defined in the project (linting rules, Prettier, etc.).
  • Write descriptive variable and function names.
  • Keep functions small and focused.

🧪 Testing

  • Add or update tests for new features or bug fixes.
  • Make sure all tests pass locally before opening a PR.

📖 Documentation

  • Update the README.md or related docs if your changes affect usage or setup.
  • Include inline comments for complex code sections.

🔍 Issues

  • Check existing issues before opening a new one.
  • Use clear, descriptive titles and provide as much context as possible.
  • If you’re working on an existing issue, comment on it to avoid duplication.

❤️ Community Standards

  • Be respectful and constructive in discussions.
  • Follow the Code of Conduct of this project.

📬 Getting Help

If you have any questions, feel free to open a discussion or reach out via the issue tracker.