GitRoot

  1---
  2target: main
  3status: done
  4reviewers: []
  5---
  6
  7# Want to merge 20253005-wording
  8
  9In this current graft, I suggest a reformulation of the GitRoot documentation.
 10Please feel free to request changes if you notice any errors, or if you feel that I have misunderstood something.
 11
 12---
 13
 14## Push 1 commit
 15
 16### :memo: Typos and wording
 17
 1883496cfbe428f1c32e6ea12e534e638cddd86d5f
 19
 20- +- [.gitroot/allowed_signers](../.gitroot/allowed_signers)
 21- +- [CHANGELOG.md](../CHANGELOG.md)
 22- +- [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md)
 23- +- [CONTRIBUTING.md](../CONTRIBUTING.md)
 24- ++ [issues/300525-fix-some-wording.md](../issues/300525-fix-some-wording.md)
 25
 26---
 27
 28## Push 1 commit
 29
 30### issue metadata added
 31
 32b505ee382eedd7de0243fae7fd0292fe6eabb417
 33
 34- -> [issues/300525-fix-some-wording.md](../issues/300525-fix-some-wording.md)
 35- +- [issues/300525-fix-some-wording.md](../issues/300525-fix-some-wording.md)
 36
 37---
 38
 39## Push 1 commit
 40
 41### :memo: Some more wordings
 42
 432f39d761c7c52e3c7fc6c7e991cfa73fb274986b
 44
 45- +- [CONTRIBUTING.md](../CONTRIBUTING.md)
 46- +- [index.md](../index.md)
 47- issues/300525-fix-some-wording.md -> [issues/close/300525-fix-some-wording.md](../issues/close/300525-fix-some-wording.md)
 48- +- [issues/close/300525-fix-some-wording.md](../issues/close/300525-fix-some-wording.md)
 49
 50---
 51
 52/review
 53/review
 54/review
 55
 56---
 57
 58Please review changes with:
 59
 60```shell
 61git fetch origin 20253005-wording
 62git checkout 20253005-wording
 63git diff origin/HEAD..HEAD
 64```
 65
 66Make your changes about the code inside the code directly (remarks, questions can be made in the form of comments). General remarks on the why can be made here. When done commit and push directly on this branch. Graft plugin will make the diff and display it here.
 67
 68---
 69
 70## Push 1 commit
 71
 72### :ok_hand: review changes and make some others
 73
 74bf56017d278eb4e129030a2abea7e06724d90f7f
 75
 76- +- [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md)
 77
 78```diff
 79= <!--
 80= SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
 81=
 82= SPDX-License-Identifier: EUPL-1.2
 83= -->
 84=
 85= # Code of Conduct
 86=
 87= The CoC in a nutshell: GitRoot and its community aim to provide a welcoming and peaceful environment for every participant at the GitRoot's events, online and offline. All participants at any GitRoot event are expected to treat each other with respect. Misbehaviour may result in exclusion from our events and/or our technical infrastructure. If you have been in a situation where the spirit of the Code of Conduct has been violated, please contact Romain (creator of GitRoot).
 88=
 89= GitRoot follows the Free Software spirit which is all about freedom and so does our community. We value collaboration and working together with respect for different opinions, skills and interests. As a welcoming community, we encourage all participants to treat each other with respect.
 90=
 91= This Code of Conduct applies to all physical GitRoot events as well as to our online infrastructure. This includes, but is not limited to, our mailing lists, wikis, social media, groups, forums and any other means of digital communication that are hosted and/or moderated by the GitRoot team. The Code of Conduct applies equally to all participants including, but not limited to, speakers, volunteers, staff, exhibitors, and so on.
 92=
 93= ## Code of Conduct
 94=
 95= We invite and encourage everyone to share their opinions on relevant topics. All participants should feel free to do so without any fear of attack, reprisal or harassment. We ask everyone to be respectful and considerate towards each other, especially when providing constructive criticism.
 96=
 97= In order to foster tolerance, respect and hospitality within our community, we agree not to engage in any discriminatory, disparaging or offensive speech or actions relating to (but not limited to) gender, sexuality, race, nationality, religion or profession. We are a community of many different nationalities and backgrounds, and we cherish our strength in rsity.
 98=
 99= CONTRIBUTING.md=If you experCONTRIBUTING.mda of behaviou/ that goes agai�principles e �@�e of Conduct//CONTRIBUTING.mdt to Romain (crr of GitRoot/CONTRIBUTING.mdible.
100=
101=
102- Pe feel free /CONTRIBUTING.md Conduct wit../CONTRIBUTING.mdonline and off discussions../CONTRIBUTING.mda respectful aelcoming env��.
103-
104+ se feel free��e the Cof Conduct wi- +- [CONTRIBUTING.md](../CONTRIBUTING.md)ussion help mainta0�0���`�*���
105�nment.
106+
107= Ќ��ngaging in m
108```
109
110```diff
111= <!--
112= SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
113=
114= SPDX-License-Identifier: EUPL-1.2
115= -->
116=
117= # Contribution guidelines
118=
119= Any issues or suggestions are welcome at [https://gitroot.dev](https://gitroot.dev).
120=
121= ## Code of conduct
122=
123= Interaction within this project is covered by the [Code of Conduct](./CODE_OF_CONDUCT.md).
124=
125= ## Scope and design goals of GitRoot
126=
127= GitRoot has a finite scope. Its purpose is to manage repositories and users. Everything else should be added into plugins. Contributions contradicting this purpose are unlikely to be accepted.
128=
129= GitRoot is responsible for security, and managing user permissions. If your contribution is not related to this, you should write a plugin.
130=
131=
132- If you are unable to write the plugin you need,  please open an issue to discuss whether GitRoot can handle the work.
133-
134+ If you are unable to write the plugin you need, please open an issue to discuss whether GitRoot can handle the work.
135+
136=
137= Plugins hosted on GitRoot itself should be open-source and serve the community. Contributions to cre
138```
139
140- +- [CONTRIBUTING.md](../CONTRIBUTING.md)
141
142```diff
143= <!--
144= SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
145=
146= SPDX-License-Identifier: EUPL-1.2
147= -->
148=
149= # Contribution guidelines
150=
151= Any issues or suggestions are welcome at [https://gitroot.dev](https://gitroot.dev).
152=
153= ## Code of conduct
154=
155= Interaction within this project is covered by the [Code of Conduct](./CODE_OF_CONDUCT.md).
156=
157= ## Scope and design goals of GitRoot
158=
159= GitRoot has a finite scope. Its purpose is to manage repositories and users. Everything else should be added into plugins. Contributions contradicting this purpose are unlikely to be accepted.
160=
161= GitRoot is responsible for security, and managing user permissions. If your contribution is not related to this, you should write a plugin.
162=
163=
164- If you are unable to write the plugin you need,  please open an issue to discuss whether GitRoot can handle the work.
165-
166+ If you are unable to write the plugin you need, please open an issue to discuss whether GitRoot can handle the work.
167+
168=
169= Plugins hosted on GitRoot itself should be open-source and serve the community. Contributions to create a new plugin may be refused at any time, for any reason (we don't have the manpower required to maintain all plugins).
170=
171= ## Creating issue/feature request/other
172=
173= To discuss about anything you should create an "issue". To do that, clone and make a file:
174=
175= - `git clone ssh://gitroot.dev/`
176= - `.gitroot/init.sh`
177= - `git checkout -b myIssue`
178= - `open issues/myIssue.md`
179= - write whatever you want in this file. Ideally, include a title and a description representing what you need
180=
181- - `git add . && git commit -m "my issue`
182-
183+ - `git add . && git commit -m "my issue"`
184+
185= - `git push origin myIssue`
186=
187= After that a maintainer will review your branch and merge it into the default branch.
188=
189= These instructions follow the classic [usage](./doc/tutorials/use_instance.md) of any GitRoot instance.
190=
191= ## Adding code
192=
193= To add some code into GitRoot project (called pull-request, merge-request or request-merge)ou need to cindex.mdbranch wa unique namindex.mdush it. , pull the c/anges made by t�rafter plugi`���
194
195is what we c//index.mdft` inRoot.
196=
197= Y/index.md link ssue to any /index.mdmoving `issues/issu../index.mdotherectory (`clo../index.mdut caange). Revie �struction the graft �=
198= Graile can be f- +- [index.md](../index.md)d`. can only fin0�0���`�*���
199`���Pp�b�Grafts do no���.**  Not all
200```
201
202```diff
203= GitRoot is a small yet powerfull git forge. Download one binary, launch it and you have a forge that can :
204=
205= - create git repositories
206= - manage who can access to what repositories
207=
208= Nothing more, nothing less.
209=
210= Install plugins and you will be able to:
211=
212= - create issues, roadmap, sprint, milestone...
213= - represent them in boards
214= - represent them all and many more in a web interface
215=
216= > All of these plugins are completely independant. Yes, you can have boards without the web interface. How ? [See raw GitRoot issues board](https://gitroot.dev/gitroot/worktree/boards/issues.md.html), try it for yourself and you will love it.
217=
218= **Wants more? Build your own plugin!**
219=
220= # Why am I doing this?
221=
222= I'm building GitRoot because I didn't find any tool that can let me do what I want for my project. But at the same time, you may want to make something different for your own project, something different of my idea o
223```
224
225- +- [index.md](../index.md)
226
227```diff
228= GitRoot is a small yet powerfull git forge. Download one binary, launch it and you have a forge that can :
229=
230= - create git repositories
231= - manage who can access to what repositories
232=
233= Nothing more, nothing less.
234=
235= Install plugins and you will be able to:
236=
237= - create issues, roadmap, sprint, milestone...
238= - represent them in boards
239= - represent them all and many more in a web interface
240=
241= > All of these plugins are completely independant. Yes, you can have boards without the web interface. How ? [See raw GitRoot issues board](https://gitroot.dev/gitroot/worktree/boards/issues.md.html), try it for yourself and you will love it.
242=
243= **Wants more? Build your own plugin!**
244=
245= # Why am I doing this?
246=
247= I'm building GitRoot because I didn't find any tool that can let me do what I want for my project. But at the same time, you may want to make something different for your own project, something different of my idea of a perfect project.
248=
249= Every project is unique, so why don't we have the freedom to modify our forge to suit our own project ?
250=
251= So I try to follow these rules when developing my forge:
252=
253= ## As a developer I want:
254=
255= - a repository containing all my data: code, issues, `(pull|merge)-request`, boards
256= - all I need to promote my project: landing page, translation, ticketing, forum
257=
258- - the ability to migrate your project into my server forge: no script migration, no loose data, no loose attribution
259-
260+ - the ability to migrate my project into a new server forge: no script migration, no loose data, no loose attribution
261+
262=
263= > As a developer I want to have a forge crafted for my unique project.
264=
265= ## As a developer I don't want:
266=
267= - to open my browser to manage my data: `(pull|merge)-request`, issues
268= - the first representation of my project is a list of files and directories
269= - my forge chooses my workflow issues: what is a sprint vs a milestone vs an epic vs an user-story?
270= - to have 100 menus to configuho can do whissues/9422-graft-need-3-review.mdant a complexege to manage/my project.
271=
272� As an adminp���$$= - an easy //issues/9422-graft-need-3-review.mdatabase
273= - onfigure wha/issues/9422-graft-need-3-review.mdequest what  want: no ne/issues/9422-graft-need-3-review.mdaccess to a pct or a feat../issues/9422-graft-need-3-review.md a forge ths easy to in../issues/9422-graft-need-3-review.mdadministrat don't want:�"headache upgrade my ��%- to giv data (or us- ++ [issues/9422-graft-need-3-review.md](../issues/9422-graft-need-3-review.md) at any timeissues/aa31-graft-mark-falsy-rename-file.md depen anyone els/.
274=
275= ### _If �are like me,С�--ot._
276=
277= It//issues/aa31-graft-mark-falsy-rename-file.mdif give me a ha/issues/aa31-graft-mark-falsy-rename-file.mdytis stored in /issues/aa31-graft-mark-falsy-rename-file.md in  git tree. E../issues/aa31-graft-mark-falsy-rename-file.mdco=
278= How can../issues/aa31-graft-mark-falsy-rename-file.md mnot? **Restrp�+ranch.**ry GitRoot r�.y comes  a `.gitroot- ++ [issues/aa31-graft-mark-falsy-rename-file.md](../issues/aa31-graft-mark-falsy-rename-file.md) you're the onne to have a20253005-wordinglt branch](.bf56017d278eb4e129030a2abea7e06724d90f7fsomeone  tries to pu:ok_hand: review changes and make some others
279if�ions.
280=
281```
282
283[CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md)
284
285```diff
286= <!--
287= SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
288=
289= SPDX-License-Identifier: EUPL-1.2
290= -->
291=
292= # Code of Conduct
293=
294= The CoC in a nutshell: GitRoot and its community aim to provide a welcoming and peaceful environment for every participant at the GitRoot's events, online and offline. All participants at any GitRoot event are expected to treat each other with respect. Misbehaviour may result in exclusion from our events and/or our technical infrastructure. If you have been in a situation where the spirit of the Code of Conduct has been violated, please contact Romain (creator of GitRoot).
295=
296= GitRoot follows the Free Software spirit which is all about freedom and so does our community. We value collaboration and working together with respect for different opinions, skills and interests. As a welcoming community, we encourage all participants to treat each other with respect.
297=
298= This Code of Conduct applies to all physical GitRoot events as well as to our online infrastructure. This includes, but is not limited to, our mailing lists, wikis, social media, groups, forums and any other means of digital communication that are hosted and/or moderated by the GitRoot team. The Code of Conduct applies equally to all participants including, but not limited to, speakers, volunteers, staff, exhibitors, and so on.
299=
300= ## Code of Conduct
301=
302= We invite and encourage everyone to share their opinions on relevant topics. All participants should feel free to do so without any fear of attack, reprisal or harassment. We ask everyone to be respectful and considerate towards each other, especially when providing constructive criticism.
303=
304= In order to foster tolerance, respect and hospitality within our community, we agree not to engage in any discriminatory, disparaging or offensive speech or actions relating to (but not limited to) gender, sexuality, race, nationality, religion or profession. We are a community of many different nationalities and backgrounds, and we cherish our strength in rsity.
305=
306= CONTRIBUTING.md=If you experCONTRIBUTING.mda of behaviou/ that goes agai�principles e �@�e of Conduct//CONTRIBUTING.mdt to Romain (crr of GitRoot/CONTRIBUTING.mdible.
307=
308=
309- Pe feel free /CONTRIBUTING.md Conduct wit../CONTRIBUTING.mdonline and off discussions../CONTRIBUTING.mda respectful aelcoming env��.
310-
311+ se feel free��e the Cof Conduct wi- +- [CONTRIBUTING.md](../CONTRIBUTING.md)ussion help mainta0�0���`�*���
312�nment.
313+
314= Ќ��ngaging in m
315```
316
317```diff
318= <!--
319= SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
320=
321= SPDX-License-Identifier: EUPL-1.2
322= -->
323=
324= # Contribution guidelines
325=
326= Any issues or suggestions are welcome at [https://gitroot.dev](htt
327```
328
329- ++ [issues/9422-graft-need-3-review.md](../issues/9422-graft-need-3-review.md)
330- ++ [issues/aa31-graft-mark-falsy-rename-file.md](../issues/aa31-graft-mark-falsy-rename-file.md)
331
332---
333
334Pffffiiiiouuu ça marche pas des masses ça 🤣
335
336Le mieux est que tu regardes mes diffs avec git ou ton ide... Désolé mais en même temps t'es le 1er donc bon... tout peu pas marcher (j'ai créé plusieurs issues au passage... c'est noraml c'est le workflow voulu) :D
337
338Est-ce que tu pourras aussi `git rebase -i main` et `fixup` tous les commits please ?? Un jour j'automatiserais avec un `/squash` mais pour le moment c'est manuel 🤷 !!
339
340---
341
342And this is the first ever graft merged 🎉🎉
343
344Very thank you Damien ❤️
345
346/merge