Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

74 lines (49 loc) · 3.13 KB

Contributing to FraudAI-Agents

Thank you for your interest in contributing to the FraudAI-Agents community! This project relies on contributions from fraud analysts, developers, and machine learning experts like you to improve and expand our collection of fraud detection agents.

Code of Conduct

Please take a moment to review our Code of Conduct to understand the expectations for participating in our community. We are committed to fostering a welcoming and inclusive environment for everyone.

How You Can Contribute

There are several ways to contribute to FraudAI-Agents:

  1. Submit a New Agent: Have a fraud detection agent idea? You can submit your own agent by following the steps below.
  2. Improve Existing Agents: Find an issue or an improvement? Help us by optimizing or improving the current fraud detection agents.
  3. Bug Reports and Feature Requests: Found a bug or have a feature request? Open an issue.
  4. Documentation: Help us improve documentation or write new tutorials.

Getting Started

  1. Fork the repository and clone it to your local machine:

    git clone https://github.com/ginix-co/giniX-Fraud-Agents.git
cd giniX-Fraud-Agents

  2. Create a new branch for your contribution:

    git checkout -b your-branch-name

  3. Install the necessary dependencies (if applicable):

    pip install -r requirements.txt

  4. Make your changes and add relevant tests.

  5. Push your branch and submit a pull request:

    git push origin your-branch-name

Submitting Your Contribution

Writing Code

  • Please follow our style guide, including proper documentation, meaningful variable names, and well-structured code.
  • Ensure your code is tested before submitting. We strive for high-quality, reliable agents.
  • For machine learning agents, clearly describe the model, data, and performance metrics in your pull request.

Pull Request Process

  1. When you submit a pull request, ensure it is linked to an open issue (if applicable) and includes a clear description of what the contribution does.
  2. Your pull request will be reviewed by one or more maintainers. We may ask questions or request changes before merging.
  3. Once approved, your pull request will be merged into the repository.

Style Guidelines

Python Style

  • Follow PEP 8 for Python code.
  • Ensure all functions and classes are documented with clear docstrings.

Fraud Detection Agent Guidelines

  • Rule-based Agents: Clearly outline the rules used for fraud detection in both the code and the documentation.
  • Machine Learning Agents: Include a brief description of the model and dataset. Ensure any trained models or datasets are included or linked to for reproducibility.

Community Support

If you need help or have any questions, please join our Discord community. We're here to support you!

Thank you for contributing to the fight against financial fraud. We look forward to seeing your amazing contributions!