-
Notifications
You must be signed in to change notification settings - Fork 6
Update CONTRIBUTING info #48
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 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 |
|---|---|---|
| @@ -1,3 +1,68 @@ | ||
| # Guidance on how to contribute | ||
|
|
||
| There are two primary ways to help: | ||
| * using the issue tracker, and | ||
| * changing the code-base. | ||
|
|
||
| ## General Remarks | ||
|
|
||
| You are welcome to contribute content (code, documentation etc.) to this open source project. | ||
|
|
||
| There are some important things to know: | ||
|
|
||
| 1. You must **comply to the license of this project**, **accept the Developer Certificate of Origin** (see below) before being able to contribute. The acknowledgement to the DCO will usually be requested from you as part of your first pull request to this project. | ||
| 2. Please **adhere to our [Code of Conduct](CODE_OF_CONDUCT.md)**. | ||
| 3. If you plan to use **generative AI for your contribution**, please see our guideline below. | ||
| 4. **Not all proposed contributions can be accepted**. Some features may fit another project better or doesn't fit the general direction of this project. Of course, this doesn't apply to most bug fixes, but a major feature implementation for instance needs to be discussed with one of the maintainers first. Possibly, one who touched the related code or module recently. The more effort you invest, the better you should clarify in advance whether the contribution will match the project's direction. The best way would be to just open an issue to discuss the feature you plan to implement (make it clear that you intend to contribute). We will then forward the proposal to the respective code owner. This avoids disappointment. | ||
|
|
||
| ## Developer Certificate of Origin (DCO) | ||
|
|
||
| Due to legal reasons, contributors will be asked to accept a DCO before they submit the first pull request to this projects, this happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/). | ||
| Contributors will be asked to accept a DCO before they submit the first pull request to this projects, this happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/). | ||
|
|
||
| ## Contributing with AI-generated code | ||
|
|
||
| As artificial intelligence evolves, AI-generated code is becoming valuable for many software projects, including open-source initiatives. While we recognize the potential benefits of incorporating AI-generated content into our open-source projects there a certain requirements that need to be reflected and adhered to when making contributions. | ||
|
|
||
| Please see our [guideline for AI-generated code contributions to SAP Open Source Software Projects](CONTRIBUTING_USING_GENAI.md) for these requirements. | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| 1. Make sure the change is welcome (see [General Remarks](#general-remarks)). | ||
| 2. Create a branch by forking the repository and apply your change. | ||
| 3. Commit and push your change on that branch. | ||
| 4. Create a pull request in the repository using this branch. | ||
| 5. Follow the link posted by the CLA assistant to your pull request and accept it, as described above. | ||
| 6. Wait for our code review and approval, possibly enhancing your change on request. | ||
| - Note that the maintainers have many duties. So, depending on the required effort for reviewing, testing, and clarification, this may take a while. | ||
| 7. Once the change has been approved and merged, we will inform you in a comment. | ||
| 8. Celebrate! | ||
|
|
||
| ## Using the issue tracker | ||
|
|
||
| Use the issue tracker to suggest feature requests, report bugs, and ask | ||
| questions. This is also a great way to connect with the developers of the | ||
| project as well as others who are interested in this solution. | ||
|
|
||
| Use the issue tracker to find ways to contribute. Find a bug or a feature, | ||
| mention in the issue that you will take on that effort, then follow the | ||
| guidance below. | ||
|
|
||
| ## Changing the code-base | ||
|
|
||
| Generally speaking, you should fork this repository, make changes in your own | ||
| fork, and then submit a pull-request. All new code should have been thoroughly | ||
| tested end-to-end in order to validate implemented features and the presence or | ||
| lack of defects. All new scripts and docker files _must_ come with automated (unit) | ||
| tests. | ||
|
|
||
| The contract of functionality exposed by docker files functionality needs | ||
| to be documented, so it can be properly used. Implementation of a functionality | ||
| and its documentation shall happen within the same commit(s). | ||
|
|
||
| #### Consistent USER Instruction in the Dockerfile | ||
|
|
||
| Set the user name (or UID) and the user group (or GID) to UID 1000 and GID 1000 to be consistent ith the Jenkins image. | ||
o-liver marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```` | ||
| USER 1000:1000 | ||
| ```` | ||
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,12 @@ | ||
| # Guideline for AI-generated code contributions to SAP Open Source Software Projects | ||
|
|
||
| As artificial intelligence evolves, AI-generated code is becoming valuable for many software projects, including open-source initiatives. While we recognize the potential benefits of incorporating AI-generated content into our open-source projects there are certain requirements that need to be reflected and adhered to when making contributions. | ||
|
|
||
| When using AI-generated code contributions in OSS Projects, their usage needs to align with Open-Source Software values and legal requirements. We have established these essential guidelines to help contributors navigate the complexities of using AI tools while maintaining compliance with open-source licenses and the broader [Open-Source Definition](https://opensource.org/osd). | ||
|
|
||
| AI-generated code or content can be contributed to SAP Open Source Software projects if the following conditions are met: | ||
|
|
||
| 1. **Compliance with AI Tool Terms and Conditions**: Contributors must ensure that the AI tool's terms and conditions do not impose any restrictions on the tool's output that conflict with the project's open-source license or intellectual property policies. This includes ensuring that the AI-generated content adheres to the [Open-Source Definition](https://opensource.org/osd). | ||
| 2. **Filtering Similar Suggestions**: Contributors must use features provided by AI tools to suppress responses that are similar to third-party materials or flag similarities. We only accept contributions from AI tools with such filtering options. If the AI tool flags any similarities, contributors must review and ensure compliance with the licensing terms of such materials before including them in the project. | ||
| 3. **Management of Third-Party Materials**: If the AI tool's output includes pre-existing copyrighted materials, including open-source code authored or owned by third parties, contributors must verify that they have the necessary permissions from the original owners. This typically involves ensuring that there is an open-source license or public domain declaration that is compatible with the project's licensing policies. Contributors must also provide appropriate notice and attribution for these third-party materials, along with relevant information about the applicable license terms. | ||
| 4. **Employer Policies Compliance**: If AI-generated content is contributed in the context of employment, contributors must also adhere to their employer’s policies. This ensures that all contributions are made with proper authorization and respect for relevant corporate guidelines. |
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.
Uh oh!
There was an error while loading. Please reload this page.