Skip to content

Latest commit

聽

History

History
52 lines (30 loc) 路 2.38 KB

CONTRIBUTING.md

File metadata and controls

52 lines (30 loc) 路 2.38 KB
Raw

Contributing to IRIS-SOAR

First and foremost, thank you for considering contributing to IRIS-SOAR! We value your time and efforts in helping our project grow and improve.

Below are some guidelines to help streamline the process of contributing to this project.

Code of Conduct

We expect all our contributors to adhere to our Code of Conduct. Please make sure to go through it before contributing.

Reporting Bugs

If you encounter any bugs or issues, please check the existing issues in our repository first to see if it has been reported. If it's a new issue, create a new issue using the appropriate template and provide as much information as possible.

Suggesting Enhancements

We welcome suggestions for improvements and new features. If you have an idea, open a new issue in the repository using the feature request template and provide a detailed description of the proposed enhancement.

Pull Requests

Here is a quick guide to creating a pull request:

  1. Fork the repository.
  2. Create a new branch with a descriptive name.
  3. Make your changes in the new branch.
  4. Commit your changes, adhering to our commit message guidelines.
  5. Push your changes to your fork on GitHub.
  6. Open a pull request against the main branch of the IRIS-SOAR repository.
  7. Describe the changes you made in the pull request description.
  8. Await review from the maintainers. We try to review all pull requests within a reasonable timeframe.

Setting Up Your Development Environment

Before you start contributing, set up a local development environment to test your changes. Follow the installation and setup guide to get started.

Running Tests

Ensure to run all the necessary tests to validate your changes. If you add new features, update or create new tests accordingly.

Documentation

Keeping the documentation up to date is crucial. Please update the documentation to reflect any changes or additions you make.

Code Style

Please adhere to the coding style and conventions used throughout the project to maintain consistency.

Getting Help

If you have any questions or need help with something, feel free to reach out to the maintainers or join our community chat.

Thank you for being a part of our contributor community! We look forward to your valuable contributions.