Your First Contribution

If you’re new to open source or this project, we recommend starting with beginner-friendly tasks. These tasks are usually labeled with “good first issue” or similar tags. To find suitable tasks, you can visit websites like makeapullrequest.com and firsttimersonly.com, which curate such opportunities across various projects.

Getting Started

To submit a contribution, follow these steps:

1. Fork the repository to your own GitHub account.
2. Create a new branch for your changes.
3. Make the necessary changes and commit them.
4. Push your branch to your forked repository.
5. Open a pull request with a descriptive title and detailed explanation of your changes.

If your contribution requires tests, make sure to include them in your pull request. Provide instructions on how to run the tests, if applicable. Additionally, if there’s a different process for submitting “small fixes,” we will communicate it to you explicitly.

Git Commit Messages

• Use Conventional Commits
• Use the imperative mood (“Move cursor to…” not “Moves cursor to…”)
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line
• When only changing documentation, include [ci skip] in the commit title

Documentation

• For new or changed features adjust the documentation files in this repository
• Document changes in CHANGELOG.md
• If user need to perform additional steps before upgrading to a version containing your changes describe these in MIGRATION.md

How to Report a Bug

If you discover a security vulnerability, do not open an issue. Instead, please email us at opensource@frachtwerk.de directly, so we can address it promptly and confidentially. For reporting non-security-related bugs, we appreciate if you can use our bug report template, which provides a structured format for gathering essential information to reproduce and understand the issue.

How to Suggest a Feature or Enhancement

We encourage suggestions for new features or enhancements that align with the project’s roadmap, goals, and development philosophy. Before submitting a suggestion, please review our existing documentation and discussions to ensure it hasn’t been proposed before. If it’s a novel idea, feel free to suggest it through the appropriate channels, providing clear and concise information about the feature’s purpose and potential benefits.