Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.25 KB

Contributing to SafeTalk-AI

First off, thanks for taking the time to contribute! 🚀

The following is a set of guidelines for contributing to the SafeTalk-AI project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document via pull request.

How to Contribute

  1. Fork the repository
  2. Create your feature branch
    git checkout -b feature/YourFeatureName
  3. Commit your changes
    Use clear and descriptive commit messages.
  4. Push to the branch
    git push origin feature/YourFeatureName
  5. Open a Pull Request
    Describe your changes in detail.

Code Style

  • Use clear, self-explanatory variable names.
  • Write comments for complex code.
  • Prefer English for code, comments, and documentation.
  • Follow PEP8 for Python and best practices for JavaScript/Node.js.

Reporting Bugs or Suggesting Features

  • Use Issues for bugs, suggestions, or feature requests.
  • Provide as much detail as possible (steps to reproduce, logs, screenshots).

Community

  • Be respectful and welcoming.
  • Assume good intentions.
  • Help others when possible.

Thank you for making SafeTalk-AI better!
— The SafeTalk-AI Team