Skip to content

Conversation

SamYuan1990
Copy link
Collaborator

pre our discussion on community session, just start this PR for our Gen AI policy discussion.
IMO, I suppose as CNCF "under" LF, and kepler is CNCF project, hence we should follow LF Gen AI policy by default.
I am not been aware of any reason today(2025-07-16) we should have our own community Gen AI policy.
If there any good lesson and learn to build a detail, community specific Gen AI policy with case study, please free to add comments in this PR and I am happy to learn from the case study.

@github-actions github-actions bot added the docs Documentation changes label Jul 16, 2025
@SamYuan1990 SamYuan1990 changed the title [doc] Add Gen AI policy in readme and contributing file [docs] Add Gen AI policy in readme and contributing file Jul 16, 2025
@SamYuan1990
Copy link
Collaborator Author

CONTRIBUTING.md:14 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Gen AI policy"]
README.md:86 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Gen AI policy"]

I don't get the point why lint fails above. @sthaha or @maryamtahhan could you please help?

@sthaha
Copy link
Collaborator

sthaha commented Jul 16, 2025

@SamYuan1990 the failure is due to markdownlint tool run by precommit.
See: instructions on setting precommit up here: https://github.com/sustainable-computing-io/kepler/blob/main/docs/developer/pre-commit.md

@SamYuan1990
Copy link
Collaborator Author

MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Gen AI policy"]

k, let's try.

CONTRIBUTING.md Outdated
@@ -11,6 +11,10 @@ Kepler is a Go-based project focused on sustainable computing. Before contributi
- Familiarize yourself with the project structure by exploring the repository
- Read our [GOVERNANCE.md](GOVERNANCE.md) and [MAINTAINERS.md](MAINTAINERS.md) documents

## Gen AI policy

Our project follow [Linux foundation Gen AI policy](https://www.linuxfoundation.org/legal/generative-ai).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

follow -> follows but .. how about?

Suggested change
Our project follow [Linux foundation Gen AI policy](https://www.linuxfoundation.org/legal/generative-ai).
Our project adheres to the Linux Foundation's Generative AI Policy, which can be viewed at [https://www.linuxfoundation.org/legal/generative-ai](https://www.linuxfoundation.org/legal/generative-ai).

Signed-off-by: SamYuan1990 <yy19902439@126.com>
@sthaha sthaha merged commit 3f467c6 into sustainable-computing-io:main Jul 17, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants