Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

76 lines (48 loc) · 3.16 KB

Contributing Guidelines

Welcome to the VirusTotal Antivirus repository! We appreciate your interest in contributing to our project. Before you get started, please take a moment to read and understand these guidelines.

Code of Conduct

We have adopted a Code of Conduct that we expect all contributors to follow. Please make sure to review and adhere to it in all interactions related to the project.

How to Contribute

We welcome contributions in various forms, including bug reports, feature requests, documentation updates, and code contributions. Here's how you can get involved:

Reporting Bugs

If you encounter a bug or issue with the project, please open a new issue on the GitHub repository. When creating a bug report, please provide as much detail as possible, including:

  • A clear and descriptive title.
  • A detailed description of the issue.
  • Steps to reproduce the bug.
  • Expected and actual results.
  • Your environment (e.g., operating system, Python version).

Requesting Features

If you have an idea for a new feature or improvement, please open a feature request. Describe the feature or enhancement you have in mind and its potential impact.

Submitting Code

If you want to contribute code to the project, please follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone your fork to your local development environment:

git clone https://github.com/your-username/your-project-name.git
  1. Create a new branch for your work:
git checkout -b feature-or-fix-name

  1. Make your changes and commit them with clear and concise messages.

  2. Push your changes to your GitHub fork:

git push origin feature-or-fix-name

  1. Create a pull request (PR) to the main repository. Please ensure that your PR includes:

    • A clear and descriptive title.
    • An explanation of the changes.
    • Any related issues or pull requests.

  2. Be responsive to comments and feedback on your pull request.

  3. Once your contribution is approved, it will be merged into the main repository.

Documentation

Improving documentation is a valuable contribution. If you find errors or missing information in the documentation, feel free to make corrections or additions.

Code Style

We follow a specific code style for this project (e.g., PEP 8 for Python). Please adhere to the existing style to maintain code consistency.

Testing

We encourage testing your code changes and submitting test cases with your contributions, especially for bug fixes and new features.

License

By contributing to this project, you agree to license your code under the project's LICENSE.

Thank you for considering contributing to VirusTotal Anti Virus! Your contributions help make the project better for everyone.

If you have any questions or need clarification on anything, please don't hesitate to reach out to us.