generated from SAP/repository-template
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update Contribution Guide with AI (#98)
- Loading branch information
1 parent
9a5adca
commit 2468273
Showing
2 changed files
with
35 additions
and
29 deletions.
There are no files selected for viewing
This file contains 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,40 +1,34 @@ | ||
| # Contributing | ||
| # Contributing to an SAP Open Source Project | ||
|
|
||
| ## Code of Conduct | ||
| ## General Remarks | ||
|
|
||
| All members of the project community must abide by the [SAP Open Source Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md). | ||
| Only by respecting each other we can develop a productive, collaborative community. | ||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [a project maintainer](.reuse/dep5). | ||
| You are welcome to contribute content (code, documentation etc.) to this open source project. | ||
|
|
||
| ## Engaging in Our Project | ||
| There are some important things to know: | ||
|
|
||
| We use GitHub to manage reviews of pull requests. | ||
| 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. | ||
|
|
||
| * If you are a new contributor, see: [Steps to Contribute](#steps-to-contribute) | ||
| ## Developer Certificate of Origin (DCO) | ||
|
|
||
| * Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced. Please note that you are willing to work on that issue. | ||
| 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/). | ||
|
|
||
| * The team will review the issue and decide whether it should be implemented as a pull request. In that case, they will assign the issue to you. If the team decides against picking up the issue, the team will post a comment with an explanation. | ||
| ## Contributing with AI-generated code | ||
|
|
||
| ## Steps to Contribute | ||
| 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. | ||
|
|
||
| Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from other contributors on the same issue. | ||
| Please see our [guideline for AI-generated code contributions to SAP Open Source Software Projects](CONTRIBUTING_USING_GENAI.md) for these requirements. | ||
|
|
||
| If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify. | ||
| ## How to Contribute | ||
|
|
||
| Please also refer to [How to Contribute](/docs/admin/dev-process/How%20to%20contribute.md). | ||
|
|
||
| ## Contributing Code or Documentation | ||
|
|
||
| You are welcome to contribute code in order to fix a bug or to implement a new feature that is logged as an issue. | ||
|
|
||
| The following rule governs code contributions: | ||
|
|
||
| * Contributions must be licensed under the [Apache 2.0 License](./LICENSE) | ||
| * Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (DCO) when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/). | ||
|
|
||
| ## Issues and Planning | ||
|
|
||
| * We use GitHub issues to track bugs and enhancement requests. | ||
|
|
||
| * Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee. | ||
| 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! |
This file contains 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. |