From c600b80d199c958356c3c0486907db9f786456b3 Mon Sep 17 00:00:00 2001 From: Klaas Freitag Date: Thu, 23 Jul 2026 14:57:39 +0200 Subject: [PATCH 1/2] Add an AI Guideline for OpenCloud plus minor adjustments in README --- profile/README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/profile/README.md b/profile/README.md index f95c46c..7e257d0 100644 --- a/profile/README.md +++ b/profile/README.md @@ -20,19 +20,18 @@ OpenCloud is an open-source project that gives you a secure and private way to store, access, and share your files. -**Benefits** +**What is OpenCloud?** -| 🀝 **Collaboration** | πŸ”’ **Data Privacy** | βš™οΈ **Simplicity** | +| 🀝 **Collaboration and Sharing** | πŸ”’ **Data Privacy** | βš™οΈ **Simplicity** | |------------------------------------|----------------------------------|--------------------------------------------| -| OpenCloud provides tools to help everyone work together, no matter where they are. | Your data stays with you, reducing the risk of unauthorized access or third-party breaches. | Minimize maintenance efforts while bringing the convenience of SaaS to your self-hosted cloud on-premises. | +| With OpenCloud people or AI can work together, with everybody with or without account and without version chaos.| Data stays under your control, reducing the risk of unauthorized access or third-party breaches. | Everybody can use it. No documentation reading required. Supported by automation, useful defaults and AI where needed. | ## How To Get Started -- **[Docker Compose](https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose-local)** 🌟 Full-blown feature set including web office and full-text search -- **[Docker](https://docs.opencloud.eu/docs/admin/getting-started/container/docker)** Classic docker setup -- **[Bare-Metal](https://docs.opencloud.eu/docs/admin/getting-started/other/bare-metal)** Manual, minimalist setup with essential features - +- Get a quick impression of OpenCloud on the [demo server](https://demo.opencloud.eu) +- Install your own installation via **[Docker Compose](https://docs.opencloud.eu/docs/admin/getting-started/container/docker-compose-local)** 🌟 Full-blown feature set including web office and full-text search +- Find [deployment options](https://docs.opencloud.eu/docs/admin/getting-started/) ## What’s Inside? @@ -93,10 +92,7 @@ OpenCloud is an open-source project that gives you a secure and private way to s ## Ways to Collaborate -There are tasks available for everyone, such as: -- Translation: You can assist in translating the UI through [Transifex](https://explore.transifex.com/opencloud-eu/opencloud-eu/) platform -- You can shape the documentation at [docs.opencloud.eu](https://docs.opencloud.eu/docs/user/) through the following repository: [docs](https://github.com/opencloud-eu/docs) - +There are ways to contribute for everyone. Please refer to the [Contribution Guidelines](https://github.com/opencloud-eu/opencloud/blob/main/CONTRIBUTING.md) for details. ## Contact Us From 444fd705198a8bc91310f3e54e93072c6700d2fa Mon Sep 17 00:00:00 2001 From: Klaas Freitag Date: Thu, 23 Jul 2026 15:00:24 +0200 Subject: [PATCH 2/2] Add guideline file --- profile/AI_GUIDELINE.md | 63 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 profile/AI_GUIDELINE.md diff --git a/profile/AI_GUIDELINE.md b/profile/AI_GUIDELINE.md new file mode 100644 index 0000000..6e7dbcf --- /dev/null +++ b/profile/AI_GUIDELINE.md @@ -0,0 +1,63 @@ + +# 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. + +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. +3. **Maintainability**: All contributions must be as "consumable" as ever possible since all contributions will be reviewed. Also, code that is written today needs to be maintained tomorrow. +5. **Human centric**: The most valuable resource is the time of human maintainers. That must be used carefully. + +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.* + +Requirements are further specified below. Contributions that do not comply with this requirements will be rejected without further discussion. + +## 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. + +### Bug Fixes +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. + +### Feature Additions +Yes, we love it, but we also apply the rules here, as we take the responsibility to maintain code that we include into the project. Try to structure the changes you plan into multiple steps to make it easier to overlook. Try to consider alternatives and document your decisions (ADR). + +Most important: make sure to talk before you invest work and tokens. There is a chance that we will not take your contribution even if it is formally great because it does not fit the roadmap. + +### "Scratch your itch" +"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. + +## 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: + +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. +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. + +These rules are mostly soft. But maintainership considers to put hard limits behind some of them in the CI which results in automatic decline of PRs in Github. + +## 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. + +1. Ask questions early. It is easier to answer a question that clarifies things than declining a PR that does not fit. +2. Be responsive. If maintainers have questions, please be responsive. +3. Be precise. Try to stick to the topic and answer questions carefully. +4. Try to act sustainable: Bigger one-off contributions are of limited use. Taking responsibility to improve and maintain a contribution over time is very appreciated. + +Please help us to refine these guidelines by submitting a PR. \ No newline at end of file