Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

66 lines (48 loc) · 2 KB

Contributing to AlertFlow

We welcome contributions to the AlertFlow project! By contributing, you help make this project better for everyone. Here are some guidelines to help you get started.

Table of Contents

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository: 
    git clone [email protected]:AlertFlow/alertflow.git
cd alertflow
  3. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name

How to Contribute

Reporting Bugs

If you find a bug in the project, please create an issue on GitHub with the following information:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • Any relevant screenshots or logs.

Suggesting Features

If you have an idea for a new feature, please create an issue on GitHub with the following information:

  • A clear and descriptive title.
  • A detailed description of the feature.
  • Any relevant mockups or examples.

Submitting Code Changes

  1. Ensure your code follows the project's coding standards and passes all tests.
  2. Commit your changes with a descriptive commit message: 
    git commit -m "Add your commit message"
  3. Push your changes to your forked repository: 
    git push origin feature/your-feature-name
  4. Open a pull request on GitHub and provide a clear description of your changes.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

License

By contributing to AlertFlow, you agree that your contributions will be licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3.