Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
25 lines (19 loc) · 868 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (19 loc) · 868 Bytes

Contributing to ChatDocAPI

Thank you for considering contributing to ChatDocAPI! Please follow these guidelines to make the process smooth for everyone.

How to Contribute

  1. Fork the repository.
  2. Clone your fork: git clone https://github.com/0xarchit/chatdoc.git
  3. Create a new branch: git checkout -b feature/my-feature
  4. Make your changes.
  5. Commit your changes: `git commit -m 'Add some feature'
  6. Push to your branch: git push origin feature/my-feature
  7. Open a Pull Request.

Code Style

  • Follow PEP8 for Python and Airbnb style guide for JavaScript/TypeScript.
  • Run linting before committing.

Reporting Issues

  • Use the bug report template for bugs.
  • Use the feature request template for enhancements.

Building & Testing

  • Backend: pip install -r requirements.txt & uvicorn main:app.
  • Frontend: npm install & npm test.