Skip to content

Contributing

Aryan Kenchappagol edited this page Jul 24, 2023 · 9 revisions

Contributing Guidelines

Welcome to OWASP's Machine Learning Security Top 10! We are thrilled that you are interested in contributing to our open-source project. By following these guidelines, you can help us maintain a welcoming and collaborative community for everyone.

Code of Conduct

Before you start contributing, please read and abide by our Code of Conduct. We expect all contributors to treat each other with respect and create a positive and inclusive environment.

Ways to Contribute

There are several ways you can contribute to our project:

Reporting Bugs:

If you find a bug or encounter an issue, please open up an issue. Before submitting a new issue, make sure you search for existing ones to avoid duplication.

Feature Requests:

If you have a feature idea or enhancement suggestion, feel free to create an issue with the "Enhancement" label.

Pull Requests:

We welcome code contributions! If you want to add a new feature or fix a bug, follow these steps:

  • Fork the repository to your GitHub account. You are more than welcome to fork the OWASP Machine Learning Security Top 10, but please abide by the Creative Commons BY-SA 4.0 license.
  • Create a new branch for your feature or fix.
  • Make your changes and commit them with descriptive messages.
  • Push your changes to your fork.
  • Submit a pull request (PR) to our repository's main branch.

Documentation: Improving our documentation is highly valuable. If you notice something unclear or missing, please submit a documentation PR.

Guidelines

To ensure smooth collaboration and maintain code quality, please follow these guidelines when submitting code:

Commit Messages:

Write clear and concise commit messages that describe the changes made in the commit.

Code Review:

Be open to feedback during the code review process. Address the feedback promptly and make necessary changes if requested.

Clone this wiki locally