From aa5d9c1aecf5433cc990793ab1c6e3aa5f6b5cda Mon Sep 17 00:00:00 2001 From: herrdeh <herr_oswald@gmx.de> Date: Tue, 3 Oct 2023 18:59:02 +0200 Subject: [PATCH 1/5] Add sub-section headings to policy. --- pages/policy.de.rst | 75 ++++++++++++++++++++++++++++----------------- pages/policy.rst | 74 +++++++++++++++++++++++++++----------------- 2 files changed, 93 insertions(+), 56 deletions(-) diff --git a/pages/policy.de.rst b/pages/policy.de.rst index 49ae779..b81e134 100644 --- a/pages/policy.de.rst +++ b/pages/policy.de.rst @@ -13,11 +13,14 @@ gelten nur wenige Regeln: Regeln ================ -* *Tryton Community* legt besonderen Wert auf Anwenderfreundlichkeit, - auch für Menschen ohne Programmierkenntnisse. - Die Idee *code is documentation* genügt uns nicht. - Jedes Projekt muss daher eine `README`-Datei enthalten, - in der beschrieben ist: +Benutzerdokumentation +----------------------- + +*Tryton Community* legt besonderen Wert auf Anwenderfreundlichkeit, +auch für Menschen ohne Programmierkenntnisse. +Die Idee *code is documentation* genügt uns nicht. +Jedes Projekt muss daher eine `README`-Datei enthalten, +in der beschrieben ist: * was tut das Modul/Programm/Skript, für welchen Zweck wurde es verfasst, @@ -30,25 +33,33 @@ Regeln * wie wird es bedient, welche Schritte sind notwendig, um es zu nutzen. - Wenn Du Unterstützung brauchst, um diese Anforderungen zu erfüllen, - helfen wir gerne. +Wenn Du Unterstützung brauchst, um diese Anforderungen zu erfüllen, +helfen wir gerne. + +Ein Projekt, das noch in Arbeit ist und aufgenommen werden möchte, +muss in der `README`-Datei +zumindest eine kurzen Beschreibung seines Zwecks enthalten. +Ein einziger Satz reicht dafür in der Regel nicht aus. +Nach Fertigstellung muss die `README`-Datei geändert werden, +um den oben genannten Anforderungen zu entsprechen. + + +Lizenzen +-------- + +Projekte müssen unter einer Freien- oder Open-Source-Lizenz lizenziert sein. +Wir empfehlen, eine von +`AGPLv3-oder-neuer`, `GPLv3-oder-neuer`, `LGPLv3-oder-neuer` oder +`FDLv1.3-oder-neuer` zu verwenden. - Ein Projekt, das noch in Arbeit ist und aufgenommen werden möchte, - muss in der `README`-Datei - zumindest eine kurzen Beschreibung seines Zwecks enthalten. - Ein einziger Satz reicht dafür in der Regel nicht aus. - Nach Fertigstellung muss die `README`-Datei geändert werden, - um den oben genannten Anforderungen zu entsprechen. -* Projekte müssen unter einer Freien- oder Open-Source-Lizenz lizenziert sein. - Wir empfehlen eine von - `AGPLv3-oder-neuer`, `GPLv3-oder-neuer`, `LGPLv3-oder-neuer` oder - `FDLv1.3-oder-neuer` zu verwenden. +Tests +------ -* Software-Projekte müssen innerhalb von 3 Monaten - nach Erstellung des Projekts eine minimale Test-Suite enthalten. - Für Module muss die Test-Suite zumindest die Standardtests der - ``ModuleTestSuite`` enthalten. +Software-Projekte müssen innerhalb von 3 Monaten +nach Erstellung des Projekts eine minimale Test-Suite enthalten. +Für Module muss die Test-Suite zumindest die Standardtests der +``ModuleTestSuite`` enthalten. * Module, die alle Tests bestehen, werden mit "Tests bestanden" gekennzeichnet. @@ -60,10 +71,14 @@ Regeln werden als "nicht testbar" gekennzeichnet und nach einiger Zeit in den „Dachboden“ verschoben. -* Es wird empfohlen, die `Tryton-Codierungsrichtlinien - <https://www.tryton.org/develop/guidelines/code>`_ zu befolgen. +Es wird empfohlen, die `Tryton-Codierungsrichtlinien +<https://www.tryton.org/develop/guidelines/code>`_ zu befolgen. -* Für Module gilt: + +Tryton-Module +------------- + +Für Module gilt: * Neue Projekte müssen mindestens die letzte Tryton-LTS-Version (Version X.0.\*) oder neuer unterstützen. @@ -80,10 +95,14 @@ Regeln muss die Datenbankstruktur für alle Veröffentlichungen dieser Hauptversion beibehalten werden. -* Jedes Projekt in der *Tryton Community* - kann seine eigenen Prozesse und speziellen Regeln aufstellen, - solange diese nicht im Widerspruch zu den Regeln der *Tryton Community* - oder des Heptapod FOSS Hosting Service stehen. + +Projektspezifische Regeln +-------------------------- + +Jedes Projekt in der *Tryton Community* +kann seine eigenen Prozesse und speziellen Regeln aufstellen, +solange diese nicht im Widerspruch zu den Regeln der *Tryton Community* +oder des Heptapod FOSS Hosting Service stehen. Nicht-Regeln diff --git a/pages/policy.rst b/pages/policy.rst index 9b5db92..1916703 100644 --- a/pages/policy.rst +++ b/pages/policy.rst @@ -11,11 +11,14 @@ To make *Tryton Community* attractive for many, only a few rules apply: Rules ================ -* *Tryton Community* puts special emphasis on user-friendliness, - also for people without programming knowledge. - The idea *code is documentation* is not enough for us. - Therefore every project must contain a `README` file. - In it is described: +User Documentation +-------------------- + +*Tryton Community* puts special emphasis on user-friendliness, +also for people without programming knowledge. +The idea *code is documentation* is not enough for us. +Therefore every project must contain a `README` file. +In it is described: * what does the module/program/script do, for what purpose was it written, @@ -28,24 +31,32 @@ Rules * how it is operated, what steps are necessary to use it. - If you need support to meet these requirements, - we are happy to help. +If you need support to meet these requirements, +we are happy to help. + +A project which is work in progress and desires to be included +must in its `README` file +contain at least a brief description of its purpose. +A single sentence is usually not sufficient. +After completion, +the `README` file must be amended to match the requirements mentioned above. + + +Licenses +----------- - A project which is work in progress and desires to be included - must in its `README` file - contain at least a brief description of its purpose. - A single sentence is usually not sufficient. - After completion, - the `README` file must be amended to match the requirements mentioned above. +Projects must be licensed under a free or open source license. +We recommend using one of `AGPLv3-or-later`, `GPLv3-or-later`, +`LGPLv3-or-later` or `FDLv1.3-or-later`. -* Projects must be licensed under a free or open source license. - We recommend using one of `AGPLv3-or-later`, `GPLv3-or-later`, - `LGPLv3-or-later` or `FDLv1.3-or-later`. -* Software projects must provide a minimal test suite within 3 month - after creation of the project. - For modules the test suite must at least include the standard - ``ModuleTestSuite``. +Tests +-------- + +Software projects must provide a minimal test suite within 3 month +after creation of the project. +For modules the test suite must at least include the standard +``ModuleTestSuite``. * Modules that pass all tests, are labeled with "Tests passed". @@ -57,12 +68,15 @@ Rules will be marked as "not testable" and moved to the “attic†after some time. -* Following the `Tryton coding guidelines - <https://www.tryton.org/develop/guidelines/code>`_ - is recommended. +Following the `Tryton coding guidelines +<https://www.tryton.org/develop/guidelines/code>`_ +is recommended. + +Tryton Modules +--------------- -* For modules applies: +For modules applies: * New projects must support at least the latest Tryton LTS version. (version X.0.\*) or newer. @@ -77,10 +91,14 @@ Rules the database structure must be kept for all releases of this major version. -* Each project in *Tryton Community* - can establish its own processes and special rules - as long as these are not contrary to the rules of *Tryton Community*, - or of the Heptapod FOSS hosting service. + +Project Specific Rules +------------------------ + +Each project in *Tryton Community* +can establish its own processes and special rules +as long as these are not contrary to the rules of *Tryton Community*, +or of the Heptapod FOSS hosting service. Non-Rules -- GitLab From 88d847b658f5498435e7321cbfe5b9dcf6d0b5d4 Mon Sep 17 00:00:00 2001 From: herrdeh <herr_oswald@gmx.de> Date: Tue, 3 Oct 2023 19:24:32 +0200 Subject: [PATCH 2/5] Add section about possible financing of enhancements. --- pages/policy.de.rst | 33 +++++++++++++++++++++++++++++++++ pages/policy.rst | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+) diff --git a/pages/policy.de.rst b/pages/policy.de.rst index b81e134..7c0a248 100644 --- a/pages/policy.de.rst +++ b/pages/policy.de.rst @@ -44,6 +44,39 @@ Nach Fertigstellung muss die `README`-Datei geändert werden, um den oben genannten Anforderungen zu entsprechen. +Bugs/RFEs - Fehlermeldungen/neue Funktionen +-------------------------------------------- + +*Tryton Community* möchte ein Ort sein, +wo von Anwender.innen gewünschte Funktionen, +die im Tryton Kern (noch) nicht realisiert wurden, +Wirklichkeit werden können. + +Konzeption und Gestalt neuer Funktionen +sollten vorab im `Tryton-Forum <https://discuss.tryton.org>`_ +diskutiert werden. +Wenn sich dort eine tragfähige Lösung herauskristallisiert hat, +kann diese im `issues-Bereich <>`_ vorgestellt werden. + +*Tryton Community* ist fest von FOSS überzeugt, +glaubt aber nicht an "immer-und-alles-kostenlos". +(Weiter-) Entwicklungen kosten Geld, +weil auch Entwickler.innen ihre Rechnungen bezahlen müssen. + +*Tryton Community* ermutigt daher Verfasser.innen +von RFEs und Fehlermeldungen, +auch einen monetären Beitrag für die Lösung des Problems anzubieten. +Dieser muss den zu erwartenden Aufwand *nicht vollständig* abdecken. +Vielmehr ist es erwünscht, daß sich andere *Community*-Mitglieder +an der Finanzierung dieser Projekte beteiligen +und in dem betreffenden issue ebenfalls einen Betrag anbieten. + +*Tryton Community* wird vorläufig +die finanziellen Beiträge informell (per E-Mail) verwalten. +Wir arbeiten an einem Konzept +für eine strukturierte Lösung des Problems. + + Lizenzen -------- diff --git a/pages/policy.rst b/pages/policy.rst index 1916703..b7298fa 100644 --- a/pages/policy.rst +++ b/pages/policy.rst @@ -42,6 +42,38 @@ After completion, the `README` file must be amended to match the requirements mentioned above. +Bugs/RFEs - error messages/new functions +------------------------------------------- + +*Tryton Community* wants to be a place +where users can ask for functions +that have not (yet) been realized in Tryton Core, +can become reality. + +The conception and design of new functions +should be discussed in advance +in the `Tryton Forum <https://discuss.tryton.org>`_. +If a viable solution has emerged there, +it can be presented in the `issues area <>`_. + +*Tryton Community* is firmly convinced of FOSS, +but does not believe in "always-and-everything-for-free". +(Further) developments cost money, +because developers have to pay their bills too. + +*Tryton Community* therefore encourages authors of RFEs and bug reports, +to offer a monetary contribution to the solution of the problem. +This does not have to cover *all* of the expected effort. +Rather, it is desirable that other *community* members +participate in the financing of these projects +and also offer an amount to the issue in question. + +*Tryton Community* will provisionally +manage the financial contributions informally (by e-mail). +We are working on a concept +for a structured solution to the problem. + + Licenses ----------- -- GitLab From cd588472cad797cb6afaf325104513c488bbaf0f Mon Sep 17 00:00:00 2001 From: Hartmut Goebel <h.goebel@crazy-compilers.com> Date: Tue, 24 Oct 2023 14:49:30 +0000 Subject: [PATCH 3/5] Apply suggestions --- pages/policy.rst | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/pages/policy.rst b/pages/policy.rst index b7298fa..8dac5ca 100644 --- a/pages/policy.rst +++ b/pages/policy.rst @@ -42,7 +42,7 @@ After completion, the `README` file must be amended to match the requirements mentioned above. -Bugs/RFEs - error messages/new functions +Funding Bug-Fixes and Enhancements ------------------------------------------- *Tryton Community* wants to be a place @@ -53,23 +53,20 @@ can become reality. The conception and design of new functions should be discussed in advance in the `Tryton Forum <https://discuss.tryton.org>`_. -If a viable solution has emerged there, -it can be presented in the `issues area <>`_. *Tryton Community* is firmly convinced of FOSS, -but does not believe in "always-and-everything-for-free". +but does not believe in "free as free beer". (Further) developments cost money, -because developers have to pay their bills too. +because developers have to pay their bills, too. -*Tryton Community* therefore encourages authors of RFEs and bug reports, +*Tryton Community* therefore encourages authors of +enhancement proposals and bug reports, to offer a monetary contribution to the solution of the problem. This does not have to cover *all* of the expected effort. Rather, it is desirable that other *community* members participate in the financing of these projects and also offer an amount to the issue in question. -*Tryton Community* will provisionally -manage the financial contributions informally (by e-mail). We are working on a concept for a structured solution to the problem. @@ -114,6 +111,7 @@ For modules applies: (version X.0.\*) or newer. * For each major version (version X.Y.\*, Y being even) + the module supports an additional branch will be created. * In order to ensure stability, changes to the database structure -- GitLab From c918d9a283929eade91e34ab11f04d6430e8c159 Mon Sep 17 00:00:00 2001 From: Hartmut Goebel <h.goebel@crazy-compilers.com> Date: Tue, 24 Oct 2023 14:54:49 +0000 Subject: [PATCH 4/5] Apply suggestions --- pages/policy.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pages/policy.rst b/pages/policy.rst index 8dac5ca..9ee4b37 100644 --- a/pages/policy.rst +++ b/pages/policy.rst @@ -67,8 +67,7 @@ Rather, it is desirable that other *community* members participate in the financing of these projects and also offer an amount to the issue in question. -We are working on a concept -for a structured solution to the problem. +We are working on a simpler solution for managing this. Licenses -- GitLab From d09c5f5e91427e3872902a0268628eba3eaa8596 Mon Sep 17 00:00:00 2001 From: Hartmut Goebel <h.goebel@crazy-compilers.com> Date: Tue, 24 Oct 2023 14:55:16 +0000 Subject: [PATCH 5/5] Apply suggesttions --- pages/policy.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pages/policy.rst b/pages/policy.rst index 9ee4b37..b82a02d 100644 --- a/pages/policy.rst +++ b/pages/policy.rst @@ -76,6 +76,9 @@ Licenses Projects must be licensed under a free or open source license. We recommend using one of `AGPLv3-or-later`, `GPLv3-or-later`, `LGPLv3-or-later` or `FDLv1.3-or-later`. +Anyway the license will have to be `compatible with Tryton +<https://www.gnu.org/licenses/gpl-faq.html#AllCompatibility>`, +which uses `GPLv3-or-later`. Tests -- GitLab