Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (62 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

87 lines (62 loc) · 2.89 KB

Contributing to Deepfake-Agentic-AI

Thank you for your interest in contributing!
We welcome contributions of all types: code, documentation, bug reports, feature requests, and ideas.
By contributing, you agree to follow our Code of Conduct and ethical AI guidelines.

1. How to Contribute

✅ Reporting Issues

  • Use GitHub Issues to report bugs, errors, or unexpected behavior.
  • Provide clear steps to reproduce, screenshots, or logs when possible.
  • Label your issue if you can (bug, feature request, question, etc.).

✅ Suggesting Enhancements

  • Open an issue with the [Feature Request] tag.
  • Explain your idea clearly and why it would benefit the project.
  • If possible, propose a solution or reference resources.

✅ Pull Requests (Code Contributions)

To contribute code, please follow these steps:

  1. Fork the repository.
  2. Create a new branch with a descriptive name: 
    git checkout -b feature/add-xyz
  3. Make your changes.
  4. Write clear and meaningful commit messages.
  5. Test your changes locally before submitting.
  6. Submit a Pull Request to the main branch including:
    • A clear description of your changes
    • The relevant issue number (if applicable)
    • Screenshots or examples (if UI/UX related)

Note: All contributions must follow ethical AI practices. Avoid adding features that can be misused for malicious deepfake generation.

2. Code Style

  • Python code should follow PEP8.
  • Use meaningful variable and function names.
  • Write modular, maintainable code.
  • Add comments and docstrings for clarity.
  • Keep pull requests small and focused for easier review.

3. Documentation

  • Good documentation is as valuable as code.
  • Update or create README sections if your feature adds new functionality.
  • Add examples for scripts, agents, or APIs.
  • Follow the existing formatting and style in Markdown.

4. Ethical Guidelines

  • This project is for research, learning, and responsible innovation.
  • Do not contribute code that enables harassment, fraud, or unlawful impersonation.
  • Always consider privacy, consent, and legality of the data you use.
  • Deepfake technology must be used ethically and responsibly.

5. Communication

  • Use GitHub Discussions, Issues, or Pull Requests to communicate.
  • Be respectful and constructive in all interactions.
  • Refer to the Code of Conduct for behavior expectations.

6. Getting Help

  • If you need guidance, ask in Issues or Discussions.
  • Maintainers will provide assistance and suggestions.
  • New contributors are encouraged to start with small issues first.

7. Thank You!

Your contributions help Deepfake-Agentic-AI grow into a safe, responsible, and innovative project.
Every improvement, big or small is always appreciated!