From d551f46bbf893fbf5306e625f945a8bc47dd3d6f Mon Sep 17 00:00:00 2001 From: Aleix Quintana Alsius Date: Sun, 23 Apr 2023 14:20:45 +0000 Subject: [PATCH] WIP contributing translate --- docs/contributing.md | 69 +++++++++++++++++--------------------------- 1 file changed, 26 insertions(+), 43 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 1058fef..3d02766 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -48,64 +48,47 @@ Some free online resources to familiarize yourself with ASD are: - [https://yewtu.be/watch?v=HXJWwxL2N5A](https://yewtu.be/watch?v=HXJWwxL2N5A) - [https://files.ifi.uzh.ch/rerg/amadeus/teaching/seminars/seminar_ws0304/06_Eberle_ASD_Folien.pdf](https://files.ifi.uzh.ch/rerg/amadeus/teaching/seminars/seminar_ws0304/06_Eberle_ASD_Folien.pdf) -### En la pràctica +### In practice -- Has detectat un problema? Ajuda'ns reportant un [problema/issue][issues]. -- Vols afegir un parche? Et pot ser útil l'apartat dels controls de qualitat - tot seguit. En funció de la complexitat dels teus canvis: +- Do you find any issue? Help us reporting the [issue][issues]. +- Do you want to add a patch? You'll find useful information in section quality control below. Depending on how complex are your changes: - - Si en són senzills, obre directament una [Merge Request][mr] - explicant el que vols afegir i per què. - D'aquesta manera iniciarà el procés de **revisió/review**. - - Si en són més complicats, potser posa't en contacte abans perquè puguem - avaluar si la teva solució és la que més s'adjusta al projecte. - Una bona manera de fer-ho és obrint una [issue][issues] explicant el que - vols fer, per què i com. + - Simple changes: Open a [Merge Request][mr] + explaining what are you adding and why. + Doing so a **review** process will be started. + - Complex changes: contact us before to decide if your solution is the optimal one for the project. + A good way of doing so is opening an [issue][issues] explaining what are you trying to to do, also why and how. -- Col·labores habitualment amb el DD? Ajuda amb les revisions de codi de les - [Merge Request][mr] pendents, tenint en compte els controls de qualitat. +- Do you often collaborate with DD? Help with the pending [Merge Request][mr] reviews, keeping in mind the quality control. [issues]: https://gitlab.com/DD-workspace/DD/-/issues [mr]: https://gitlab.com/DD-workspace/DD/-/merge_requests -## Controls de qualitat +## Quality controls ### Continuous Integration -Per simplificar la feina de revisió de codi i assegurar una certa qualitat del -que entra al repositori: +To simplify the review work and to ensure certain quality of what is integrated in repository: -- Ningú pot fer `push` a la branca principal (`main`) directament. - Sempre és necessari passar pel procés de [Merge Request][mr] i review. -- Disposem d'una instància de [buildbot][buildbot] com a Continuous Integration - (a `ci.dd-work.space`, login amb GitLab) que reacciona a esdeveniments de - tipus `push` al repositori principal, i de tipus [Merge Request][mr] des de - qualsevol repositori. - - Quan es tracta d'un [Merge Request][mr], només s'executen comprovacions - de estàtiques, que no executen el codi del repositori. - Això és per evitar abús de tipus mineria de criptomonedes i demés. - Aquestes comprovacions ara mateix són: - [ShellCheck][sc] per scripts de shell, [mkdocs][mkdocs] per comprovar - que la documentació es genera correctament, i aviat hi afegirem linters i - comprovadors estàndard de Python. - - Quan es tracta d'un esdeveniment `push` al repositori principal, - addicionalment a les comprovacions anteriors, es comença el procés - d'instal·lació des de zero en una màquina virtual. - Això ajuda a detectar quan s'introdueixen problemes i a assegurar que el - DD es pot instal·lar correctament. -- Els membres del grup `DD-workspace` a GitLab tenen permisos d'administració a - la instància de Buildbot, això els permet iniciar builds manualment o - cancel·lar tasques si és necessari. +- Nobody can direct `push` to `main` branch (`main`). + Always is necessary to follow the [Merge Request][mr] review proces. +- ** TO BE REVIEWED ( branch based events?? )** There is a [buildbot][buildbot] instance (in `ci.dd-work.space`, login via GitLab) as a Continuous Integration that reacts to `push` events in `main` branch and to [Merge Request][mr] events in any other branch. + - When the event is a [Merge Request][mr], only static checks are executed, so no complete tests are launched. + This is to prevent crypto mining CI/CD abuse. + These checks are the same as: + [ShellCheck][sc] for shell scripts, [mkdocs][mkdocs] to check that the documentation is generated as it should, soon we'll add linters and standard python checks. + - When the event is a `push` to `main`, + additionally to the [Merge Request][mr] tests, it will start the installation process from the scratch in a virtual machine. + This helps in detecting problems and makes sure that DD can be correctly. +- Members of group `DD-workspace` in Gitlab have administration permissions in Buildbot instance, this allow them to start or cancel build tasks manually if it is required. ### Checklist -Abans d'aprovar una Merge Request, hem de fer les següents comprovacions als -canvis que es volen introduir: +Before testing a Merge Request, we need to do these tests on the changes introduced: -- [ ] Passen les comprovacions a la CI -- [ ] Les modificacions introduïdes són necessàries, solucionen un problema - real, o milloren la mantenibilitat del projecte -- [ ] Es consideren i debaten les implicacions de **seguretat** +- [ ] CI Tests passing. +- [ ] The changes are needed, and solves a real problem. Also the changeset improves the maintenance of the project. +- [ ] ConsiderateEs consideren i debaten les implicacions de **seguretat** - [ ] Es consideren i debaten les implicacions de **mantenibilitat** - [ ] Es revisen possibles regressions de funcionalitat - [ ] No s'utilitzen dades reals en les proves