Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (19 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 1.51 KB
Raw

Contributing to PRAMAAN

First off, thank you for considering contributing to PRAMAAN! We value community input and are excited to see how you can help improve the platform.

How Can I Contribute?

Reporting Bugs

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

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue and detail your feature request.
  • Explain why this enhancement would be useful to most users, especially focusing on digital forensics and integrity verification workflows.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Code Style

We follow PEP 8 standard for Python code. Please ensure you run linters (e.g., flake8 or black) before submitting your pull request. Refer to the Developer Setup for more details.