CONTRIBUTING

First of all, thank you for your interest in contributing to this project!
We are excited to have you here. This is a public project, and we welcome
any and all contributions.

Your feedback, criticism, and suggestions are highly valued. Every
contribution, no matter how small, helps make this project better.

If you like the project, please consider giving it a ⭐ on GitLab!

How You Can Contribute

There are several ways you can contribute to this project:

• Reporting Bugs: If you find a bug, please let us know by opening
  an issue on GitLab or by sending an email.
• Suggesting Enhancements: Have an idea for a new feature or an
  improvement to an existing one? We'd love to hear it.
• Providing Feedback: General feedback and discussions are always
  welcome. Feel free to reach out to the main author.
• Code Contributions: You can contribute directly to the codebase by
  fixing bugs or adding new features.

Submitting Changes

The process for submitting code changes is still evolving, but we generally
follow two main paths. Please choose the one that works best for you.

1. Informal Suggestions via Email

For quick ideas, minor fixes, or if you're not yet comfortable with the
formal Merge Request process, you can simply send your suggestions or code
snippets via email to the main author:

Andreas Muckenschnabel: andreas.muckenschnabel@studium.fernuni-hagen.de

2. Using GitLab Merge Requests

For more significant changes, the preferred method is to use GitLab's Merge
Request workflow. This helps us track changes and review them effectively.

1. Fork the repository on GitLab.
2. Create a new branch for your changes in your forked repository. A good
   branch name would be feature/your-new-feature or fix/bug-description.
   

   git checkout -b feature/my-amazing-feature

3. Make your changes and commit them with a clear, descriptive commit
   message.
   

   git commit -m "feat: Add amazing new feature"

4. Push your branch to your forked repository on GitLab.
   

   git push origin feature/my-amazing-feature

5. Open a Merge Request from your branch to the main branch of this
   repository. Please provide a clear title and description for your changes.

License

This project is licensed under the GNU General Public License v3.0. A
copy of the license should be available in the LICENSE file in this
repository.

By contributing to this project, you agree that your contributions will be
licensed under the same GPL-3.0 license.

Contact

If you have any questions, feel free to contact the main author:

• Andreas Muckenschnabel: andreas.muckenschnabel@studium.fernuni-hagen.de

Thank you again for your contribution!