-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add license & readme file #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2025 J&J Ideenschmiede GmbH | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Security Policy | ||
|
|
||
| ## Supported Versions | ||
|
|
||
| As this project serves as the backend for an application, we are committed to maintaining the security of our platform by ensuring that only the most recent release is supported with security updates. Once a new version is released, it is immediately deployed, rendering the previous version obsolete in a live environment. Therefore, we encourage all users to keep their systems up to date with the latest release to benefit from the latest security enhancements. | ||
|
|
||
| | Version | Supported | | ||
| |-------------------|--------------------| | ||
| | Latest Release | :white_check_mark: | | ||
| | Previous Releases | :x: | | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| If you notice a security vulnerability, we encourage you to take an active role in our security process by directly creating a pull request with the necessary adjustments to address the issue. This proactive approach helps us ensure that vulnerabilities are swiftly resolved, maintaining the integrity and safety of our project. | ||
|
|
||
| When creating a pull request to address a security vulnerability, please include: | ||
|
|
||
| - A detailed description of the vulnerability and its potential impact. | ||
| - A step-by-step guide to reproduce the issue, if applicable. | ||
| - The specific changes you propose to mitigate the vulnerability. | ||
| - Any additional information or context that might help in the assessment and resolution of the problem. | ||
|
|
||
| This direct method of reporting and resolving security issues facilitates a more efficient and effective response, allowing us to implement security improvements with the help of our community. We appreciate your contributions to making our project more secure. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Encouraging public pull requests for security vulnerabilities is a security concern. This approach exposes vulnerabilities publicly before they are fixed, potentially allowing malicious actors to exploit them. Consider implementing a private disclosure process (e.g., security@company.com) or using GitHub's private security advisory feature instead.