Skip to content

Latest commit

 

History

History
70 lines (42 loc) · 2.13 KB

contributing.md

File metadata and controls

70 lines (42 loc) · 2.13 KB
Raw

Contributing to AlertWave

Thank you for your interest in contributing to AlertWave! We welcome contributions from the community, whether it's bug reports, feature requests, code improvements, or documentation updates.

Before getting started, please take a moment to review our Code of Conduct. By participating in this project, you agree to abide by its terms.

How to Contribute

Reporting Issues

If you encounter a bug, have a feature request, or want to suggest an improvement, please check the Issues section to see if the topic has already been discussed. If not, feel free to open a new issue and provide as much detail as possible.

Code Contributions

Fork the Repository

  1. Fork the repository to your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/toth2000/alertWave.git

  3. Create a new branch for your feature or bug fix:

    git checkout -b feature-name

Make Changes

Make your changes, ensuring that your code follows the project's coding standards.

Test

If applicable, add tests to cover your changes. Ensure that all tests pass.

Commit and Push

Commit your changes and push them to your forked repository:

git add .
git commit -m "Your descriptive commit message"
git push origin feature-name

Create Pull Request

  1. Navigate to your forked repository on GitHub.
  2. Click on the "New Pull Request" button.
  3. Provide a clear title and description for your pull request.
  4. Submit the pull request.

Documentation Contributions

If you want to contribute to documentation:

  1. Make your changes or add new documentation.
  2. Follow the same process as outlined for code contributions to create a pull request.

Code of Conduct

Please review our Code of Conduct before contributing. Help us ensure a welcoming and respectful community.

License

By contributing to AlertWave, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to AlertWave! 🚀