Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (28 loc) · 1004 Bytes

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1004 Bytes
Raw

Contributing to TDOC

First off, thank you for your interest in contributing to TDOC! We welcome contributions of all kinds, whether it's reporting bugs, suggesting features, improving documentation, or submitting code.

How to Contribute

1. Reporting Bugs

If you find a bug:

  • Check the GitHub issues to see if it's already reported.
  • If not, open a new issue with:
    • Steps to reproduce
    • Expected behavior vs actual behavior
    • TDOC version (tdoc status)
    • Screenshots or logs if applicable

Do NOT include sensitive info like API keys, passwords, or personal data.

2. Suggesting Features

We love feature ideas!

  • Open a new GitHub issue with:
    • Clear description of the feature
    • Use case / benefit
    • Example commands or UX ideas if possible

3. Submitting Code

a. Fork & Branch

  1. Fork the repository
  2. Create a new branch with a descriptive name:

``bash git checkout -b feature/awesome-fix