Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (55 loc) · 4.06 KB

CONTRIBUTING.md

File metadata and controls

84 lines (55 loc) · 4.06 KB
Raw

<<<<<<< HEAD

Contributing to KAVACH-AI

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

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

Code of Conduct

This project and everyone participating in it is governed by the KAVACH-AI Code of Conduct. By participating, you are expected to uphold this code.

Contributing to Multimodal Deepfake Detection System Using Advanced Machine Learning Techniques

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

The following is a set of guidelines for contributing to Multimodal Deepfake Detection System Using Advanced Machine Learning Techniques and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the Multimodal Deepfake Detection System Using Advanced Machine Learning Techniques Code of Conduct. By participating, you are expected to uphold this code.

7df14d1 (UI enhanced)

How Can I Contribute?

Reporting Bugs

<<<<<<< HEAD This section guides you through submitting a bug report for KAVACH-AI. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

This section guides you through submitting a bug report for Multimodal Deepfake Detection System Using Advanced Machine Learning Techniques. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

7df14d1 (UI enhanced)

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps to reproduce the problem in as much detail as possible.
  • Provide specific examples to demonstrate the steps.

Suggesting Enhancements

<<<<<<< HEAD This section guides you through submitting an enhancement suggestion for KAVACH-AI, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.

  • Provide a step-by-step description of the suggested enhancement in as much detail as possible.

  • Explain why this enhancement would be useful to most KAVACH-AI users. ======= This section guides you through submitting an enhancement suggestion for Multimodal Deepfake Detection System Using Advanced Machine Learning Techniques, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.

  • Provide a step-by-step description of the suggested enhancement in as much detail as possible.

  • Explain why this enhancement would be useful to most Multimodal Deepfake Detection System Using Advanced Machine Learning Techniques users.

7df14d1 (UI enhanced)

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the Python PEP8 style guide for backend code.
  • Follow the AirBnB React style guide for frontend code.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Python Styleguide

All Python code is linted with flake8 and formatted with black.

JavaScript Styleguide

All JavaScript code is linted with eslint and formatted with prettier.

Additional Resources

Thank you for your contributions!