Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

73 lines (52 loc) · 2.1 KB

#Contributing to ContentVeritas

We welcome contributions to ContentVeritas Technologies! Whether you're fixing bugs, improving documentation, or building new features, your help makes a difference.

🧱 Ground Rules

  • Be respectful and inclusive
  • Focus on clear, useful, and testable contributions
  • Follow code style conventions for the language (Python, JS, etc.)
  • File issues before starting large features

🚀 Getting Started

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/your-username/repo-name
cd repo-name
  3. Create a feature branch: 
    git checkout -b feature/your-feature-name
  4. Make your changes (be sure to test!)
  5. Commit and push: 
    git add .
git commit -m "Add: brief description of change"
git push origin feature/your-feature-name
  6. Open a pull request with a clear summary and reference to issues (if applicable)

🧪 Code Standards

Repo Standards
python-sdk Follow PEP8
javascript-sdk Use ESLint defaults or extend Airbnb
api-docs Use valid Markdown and JSON examples
examples Keep code short, well-commented, and language-idiomatic

Use meaningful commit messages and submit small, focused PRs.

🧰 Tooling

  • Lint and format your code before submitting
  • Include unit or integration tests where appropriate
  • Use .env.example for any required configuration

🔒 Security & Responsible Disclosure

If you discover a security vulnerability, please DO NOT submit an issue or PR.
Instead, report it privately to security@contentveritas.com and we'll coordinate a response.

📞 Questions?

Thank you for helping make ContentVeritas better!