Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.46 KB

Contributing

Thank you for your interest in contributing to line-commenter-tool! We welcome bug reports, enhancements, documentation improvements, and tests.

Please follow these guidelines to make contribution easier to review and merge.

  1. File an Issue

    • Open an issue to discuss your idea or bug before doing a large change.
    • Use clear, descriptive titles and provide reproduction steps where applicable.

  2. Fork & Branch

    • Fork the repository and create a topic branch for your work: git checkout -b my-feature-branch

  3. Make Small, Focused Changes

    • Keep each PR focused on a single issue or feature.
    • Add tests for new behavior where relevant.

  4. Code Style

    • Follow existing code style. Use the same lint rules and formatting used in the project.
    • Run tests and linters before opening a PR.

  5. Commit Messages

    • Use clear, imperative commit messages (e.g., "Fix issue with multiline comment detection").
    • Squash minor or WIP commits where appropriate before merging.

  6. Testing

    • Add or update tests for new features and bug fixes.
    • Ensure the test suite passes locally.

  7. Pull Request

    • Open a PR against the main branch with a clear title and description.
    • Reference related issues (e.g., "Fixes #123").
    • Describe the changes and any migration or compatibility notes.

  8. Code of Conduct

    • By participating, you agree to follow the Code of Conduct in CODE_OF_CONDUCT.md.

Thank you — all contributions are appreciated!