Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (68 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

99 lines (68 loc) · 2.19 KB
Raw

Contributing to this repository

Thank you for considering contributing to this project! Your help is greatly appreciated. This document outlines the process for contributing, reporting issues, and submitting improvements.

1. How to Contribute

Fork & Clone

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/{your-username}/{repository}.git
  3. Navigate into the project folder: 
    cd {repository}

Branches

  • Use descriptive branch names:
    • feature/your-feature-name for new features
    • bugfix/issue-name for bug fixes
    • hotfix/urgent-fix for urgent fixes
  • Always branch off main (or master if used).

Commits

  • Write clear, concise commit messages.
  • Follow Conventional Commits if possible: 
    type(scope): short description
    Example: feat(api): add authentication endpoint

Pull Requests

  • Push your branch to your fork.
  • Open a pull request (PR) against the main repository.
  • Include:
    • Description of your changes
    • Link to any related issues
    • Screenshots or logs if applicable

2. Reporting Bugs

  • Open an issue with a clear title.
  • Include:
    • Steps to reproduce
    • Expected vs actual behavior
    • Environment details (OS, versions, dependencies)
    • Error messages or logs

3. Suggesting Features

  • Open an issue before starting work.
  • Describe your feature request and why it is useful.
  • Maintain discussion with maintainers before implementation.

4. Code Style & Conventions

  • Follow existing code style and formatting.
  • Use linters/formatters if configured.
  • Keep naming consistent and readable.
  • Ensure compatibility with minimum required dependencies.

5. Running Tests

  • Run existing tests before submitting PR: 
    pytest          # Example for Python projects
  • Add new tests for new features or bug fixes.

6. Communication

  • For questions, reach out via GitHub issues or contact [maintainer email].
  • Be respectful and follow the Code of Conduct.

7. Checklist Before Submitting a PR

Thank you for helping improve this repository!