[WIP] Add an AI Guideline for OpenCloud plus minor adjustments in README by dragotin · Pull Request #29 · opencloud-eu/.github

dragotin · 2026-07-23T12:59:53Z

This is a WIP of the AI guideline for the OpenCloud project.
Feel free to review and discuss.

Once we have a agreed version it will be linked from the organization main README.

AlexAndBear · 2026-07-24T03:25:37Z

+Bug fixes in form of "one-liners", typo fixes, fixes to translations and such are always very appreciated. Never think "that is too trivial to submit", it is not.
+
+### Refactorings
+Bigger changes that fix misbehaviour, refactor parts of the codebase are also appreciated, but be careful. Have tests and keep changes small. Possibly talk before submitting what the maintainers think of your idea.


Suggested change

Bigger changes that fix misbehaviour, refactor parts of the codebase are also appreciated, but be careful. Have tests and keep changes small. Possibly talk before submitting what the maintainers think of your idea.

Bigger changes that fix misbehaviour, refactor parts of the codebase are also appreciated, but be careful. Have tests and keep changes small. Possibly ask before submitting what the maintainers think of your idea.

AlexAndBear · 2026-07-24T03:28:01Z

+
+This is done to protect OpenCloud, especially with regards to the following points: 
+
+1. **Code Quality**: OpenCloud has a strong focus on code quality as we know that dealing with users data comes with a great responsibility for data security. All contributions have to put that first.


Suggested change

1. **Code Quality**: OpenCloud has a strong focus on code quality as we know that dealing with users data comes with a great responsibility for data security. All contributions have to put that first.

1. **Code Quality**: OpenCloud has a strong focus on code quality as we know that dealing with user data comes with a great responsibility for data security. All contributions have to put that first.

AlexAndBear · 2026-07-24T03:28:28Z

+This is done to protect OpenCloud, especially with regards to the following points: 
+
+1. **Code Quality**: OpenCloud has a strong focus on code quality as we know that dealing with users data comes with a great responsibility for data security. All contributions have to put that first.
+2. **Focus**: OpenCloud serves a certain purpose which is defined very carefully by product managenment. All contributions have to align with that roadmap.


Suggested change

2. **Focus**: OpenCloud serves a certain purpose which is defined very carefully by product managenment. All contributions have to align with that roadmap.

2. **Focus**: OpenCloud serves a certain purpose which is defined very carefully by product management. All contributions have to align with that roadmap.

AlexAndBear · 2026-07-24T03:29:17Z

+
+## Fit to the Project
+
+Before submitting a PR to any repository of OpenCloud, think about it's size and fit to the project. That is a major factor on how careful the PR needs to be prepared and how maintainer look at it.


Suggested change

Before submitting a PR to any repository of OpenCloud, think about it's size and fit to the project. That is a major factor on how careful the PR needs to be prepared and how maintainer look at it.

Before submitting a PR to any repository of OpenCloud, think about its size and fit to the project. That is a major factor on how careful the PR needs to be prepared and how maintainers look at it.

AlexAndBear · 2026-07-24T03:32:10Z

+"Scratching your own itch" and pushing the results upstream is in general a great motivation to contribute to open source projects. OpenCloud supports that idea. 
+However, we have to keep the main direction of the project in mind, so we can not accept every "special purpose" feature.
+
+Make sure to find a ballance between functions that are good for everybody and your own needs. You will have to keep private patches for some of your additions.


Suggested change

Make sure to find a ballance between functions that are good for everybody and your own needs. You will have to keep private patches for some of your additions.

Make sure to find a balance between functions that are good for everybody and your own needs. You will have to keep private patches for some of your additions.

AlexAndBear · 2026-07-24T03:32:31Z

+
+## Pull Requests
+
+Contributions to all parts of the project are very appreciated. To submit a contribution via Github Pull Requests,  the following points need to be considered:


Suggested change

Contributions to all parts of the project are very appreciated. To submit a contribution via Github Pull Requests, the following points need to be considered:

Contributions to all parts of the project are very appreciated. To submit a contribution via GitHub Pull Requests, the following points need to be considered:

AlexAndBear · 2026-07-24T03:35:42Z

+
+## Human interaction
+
+OpenCloud is and will be a human driven project. Keep that in mind with every contribution and interaction. Beside a friendly and patient attitude, a human friendly style of communication and working is expected.


Suggested change

OpenCloud is and will be a human driven project. Keep that in mind with every contribution and interaction. Beside a friendly and patient attitude, a human friendly style of communication and working is expected.

OpenCloud is and will be a human driven project. Keep that in mind with every contribution and interaction. Besides a friendly and patient attitude, a human friendly style of communication and working is expected.

JammingBen · 2026-07-24T04:41:56Z

+# AI Contributions
+
+AI usage is causing challenges for all open source projects, so for OpenCloud.
+This document will set up guidelines how we work with AI and how we ask contributors to work with it. 


Suggested change

This document will set up guidelines how we work with AI and how we ask contributors to work with it.

This document sets up guidelines how we work with AI and how we ask contributors to work with it.

JammingBen · 2026-07-24T04:42:12Z

+
+These points can be summarized in a fundamental principle for OpenCloud in relation to AI:
+
+>*OpenCloud is a project driven by responsible humans. We take a positive view on using AI as a tool to speed up and refine work. However, we expect that human work habits and processes are always  respected. For every contribution a person is held accountable.*


Suggested change

>*OpenCloud is a project driven by responsible humans. We take a positive view on using AI as a tool to speed up and refine work. However, we expect that human work habits and processes are always respected. For every contribution a person is held accountable.*

>*OpenCloud is a project driven by responsible humans. We take a positive view on using AI as a tool to speed up and refine work. However, we expect that human work habits and processes are always respected. For every contribution a person is held accountable.*

JammingBen · 2026-07-24T04:42:26Z

+
+>*OpenCloud is a project driven by responsible humans. We take a positive view on using AI as a tool to speed up and refine work. However, we expect that human work habits and processes are always  respected. For every contribution a person is held accountable.*
+
+Requirements are further specified below. Contributions that do not comply with this requirements will be rejected without further discussion.


Suggested change

Requirements are further specified below. Contributions that do not comply with this requirements will be rejected without further discussion.

Requirements are further specified below. Contributions that do not comply with these requirements will be rejected without further discussion.

JammingBen · 2026-07-24T05:18:44Z

+"Scratching your own itch" and pushing the results upstream is in general a great motivation to contribute to open source projects. OpenCloud supports that idea. 
+However, we have to keep the main direction of the project in mind, so we can not accept every "special purpose" feature.
+
+Make sure to find a ballance between functions that are good for everybody and your own needs. You will have to keep private patches for some of your additions.


Maybe worth adding a sentence about the web-extension framework as a way to add functionality without necessarily committing all of it upstream?

JammingBen · 2026-07-24T05:20:04Z

+1. YOU are responsible for what you submit, not your agent. Make sure you completely understand what you submit. Be able to answer questions. Be open about your way to use AI. 
+2. Keep PRs short. The shorter the better, as that is easier for humans. Split code contributions to multiple PRs. Invest time in finding logical portions of bigger contributions and reference the PRs accordingly.
+3. Authorship is for humans, not tools. Code assistants and such should not be described in commits using tags like "Co-authored-by" or similar. Nor must they be listed as primary author. 
+4. To be sensitive about others time, keep descriptions short and concise. Another person should understand your idea within tem seconds. Consider splitting your comments to a summary on top and detailed description below. 


Suggested change

4. To be sensitive about others time, keep descriptions short and concise. Another person should understand your idea within tem seconds. Consider splitting your comments to a summary on top and detailed description below.

4. To be sensitive about others time, keep descriptions short and concise. Another person should understand your idea within ten seconds. Consider splitting your comments to a summary on top and detailed description below.

JammingBen · 2026-07-24T05:21:12Z

+3. Authorship is for humans, not tools. Code assistants and such should not be described in commits using tags like "Co-authored-by" or similar. Nor must they be listed as primary author. 
+4. To be sensitive about others time, keep descriptions short and concise. Another person should understand your idea within tem seconds. Consider splitting your comments to a summary on top and detailed description below. 
+5. Check your contribution: Review your AI generated PR carefully before submitting it. Abstain from copy & paste. It is YOU who submits it, not an AI. Maintain your contributor reputation.
+6. Add useful comments, tests and documentation additions to your contribution. AI is a great  help for that.


Suggested change

6. Add useful comments, tests and documentation additions to your contribution. AI is a great help for that.

6. Add useful comments, tests and documentation additions to your contribution. AI is a great help for that.

dragotin added 2 commits July 23, 2026 14:57

Add an AI Guideline for OpenCloud plus minor adjustments in README

c600b80

Add guideline file

444fd70

dragotin requested a review from tbsbdr July 23, 2026 14:08

AlexAndBear requested changes Jul 24, 2026

View reviewed changes

JammingBen reviewed Jul 24, 2026

View reviewed changes

	Bigger changes that fix misbehaviour, refactor parts of the codebase are also appreciated, but be careful. Have tests and keep changes small. Possibly talk before submitting what the maintainers think of your idea.
	Bigger changes that fix misbehaviour, refactor parts of the codebase are also appreciated, but be careful. Have tests and keep changes small. Possibly ask before submitting what the maintainers think of your idea.


		This is done to protect OpenCloud, especially with regards to the following points:

		1. Code Quality: OpenCloud has a strong focus on code quality as we know that dealing with users data comes with a great responsibility for data security. All contributions have to put that first.

	2. Focus: OpenCloud serves a certain purpose which is defined very carefully by product managenment. All contributions have to align with that roadmap.
	2. Focus: OpenCloud serves a certain purpose which is defined very carefully by product management. All contributions have to align with that roadmap.


		## Fit to the Project

		Before submitting a PR to any repository of OpenCloud, think about it's size and fit to the project. That is a major factor on how careful the PR needs to be prepared and how maintainer look at it.

	Make sure to find a ballance between functions that are good for everybody and your own needs. You will have to keep private patches for some of your additions.
	Make sure to find a balance between functions that are good for everybody and your own needs. You will have to keep private patches for some of your additions.


		## Pull Requests

		Contributions to all parts of the project are very appreciated. To submit a contribution via Github Pull Requests, the following points need to be considered:


		## Human interaction

		OpenCloud is and will be a human driven project. Keep that in mind with every contribution and interaction. Beside a friendly and patient attitude, a human friendly style of communication and working is expected.

	This document will set up guidelines how we work with AI and how we ask contributors to work with it.
	This document sets up guidelines how we work with AI and how we ask contributors to work with it.


		These points can be summarized in a fundamental principle for OpenCloud in relation to AI:

		>OpenCloud is a project driven by responsible humans. We take a positive view on using AI as a tool to speed up and refine work. However, we expect that human work habits and processes are always respected. For every contribution a person is held accountable.


		>OpenCloud is a project driven by responsible humans. We take a positive view on using AI as a tool to speed up and refine work. However, we expect that human work habits and processes are always respected. For every contribution a person is held accountable.

		Requirements are further specified below. Contributions that do not comply with this requirements will be rejected without further discussion.

	4. To be sensitive about others time, keep descriptions short and concise. Another person should understand your idea within tem seconds. Consider splitting your comments to a summary on top and detailed description below.
	4. To be sensitive about others time, keep descriptions short and concise. Another person should understand your idea within ten seconds. Consider splitting your comments to a summary on top and detailed description below.

	6. Add useful comments, tests and documentation additions to your contribution. AI is a great help for that.
	6. Add useful comments, tests and documentation additions to your contribution. AI is a great help for that.

Uh oh!

Conversation

dragotin commented Jul 23, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexAndBear Jul 24, 2026 • edited by JammingBen Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AlexAndBear Jul 24, 2026 •

edited by JammingBen

Loading