In this current graft, I suggest a reformulation of the GitRoot documentation. Please feel free to request changes if you notice any errors, or if you feel that I have misunderstood something.
83496cfbe428f1c32e6ea12e534e638cddd86d5f
b505ee382eedd7de0243fae7fd0292fe6eabb417
2f39d761c7c52e3c7fc6c7e991cfa73fb274986b
/review /review /review
Please review changes with:
1git fetch origin 20253005-wording
2git checkout 20253005-wording
3git diff origin/HEAD..HEAD
Make 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.
bf56017d278eb4e129030a2abea7e06724d90f7f
1= <!--
2= SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
3=
4= SPDX-License-Identifier: EUPL-1.2
5= -->
6=
7= # Code of Conduct
8=
9= 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).
10=
11= 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.
12=
13= 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.
14=
15= ## Code of Conduct
16=
17= 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.
18=
19= 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.
20=
21= CONTRIBUTING.md= If you experCONTRIBUTING.mda of behaviou/ that goes agai� principles e � @� e of Conduct//CONTRIBUTING.mdt to Romain (cr r of GitRoot/CONTRIBUTING.md ible.
22=
23=
24- P e feel free /CONTRIBUTING.md Conduct wit../CONTRIBUTING.mdonline and off discussions../CONTRIBUTING.mda respectful a elcoming env�� .
25-
26+ se feel free�� e the Co f Conduct wi- +- [CONTRIBUTING.md](../CONTRIBUTING.md)ussion help mainta0� 0 �� � `� * �� �
27 � nment.
28+
29= Ќ �� ngaging in m
1= <!--
2= SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
3=
4= SPDX-License-Identifier: EUPL-1.2
5= -->
6=
7= # Contribution guidelines
8=
9= Any issues or suggestions are welcome at [https://gitroot.dev](https://gitroot.dev).
10=
11= ## Code of conduct
12=
13= Interaction within this project is covered by the [Code of Conduct](./CODE_OF_CONDUCT.md).
14=
15= ## Scope and design goals of GitRoot
16=
17= 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.
18=
19= GitRoot is responsible for security, and managing user permissions. If your contribution is not related to this, you should write a plugin.
20=
21=
22- If you are unable to write the plugin you need, please open an issue to discuss whether GitRoot can handle the work.
23-
24+ If you are unable to write the plugin you need, please open an issue to discuss whether GitRoot can handle the work.
25+
26=
27= Plugins hosted on GitRoot itself should be open-source and serve the community. Contributions to cre
1= <!--
2= SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
3=
4= SPDX-License-Identifier: EUPL-1.2
5= -->
6=
7= # Contribution guidelines
8=
9= Any issues or suggestions are welcome at [https://gitroot.dev](https://gitroot.dev).
10=
11= ## Code of conduct
12=
13= Interaction within this project is covered by the [Code of Conduct](./CODE_OF_CONDUCT.md).
14=
15= ## Scope and design goals of GitRoot
16=
17= 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.
18=
19= GitRoot is responsible for security, and managing user permissions. If your contribution is not related to this, you should write a plugin.
20=
21=
22- If you are unable to write the plugin you need, please open an issue to discuss whether GitRoot can handle the work.
23-
24+ If you are unable to write the plugin you need, please open an issue to discuss whether GitRoot can handle the work.
25+
26=
27= 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).
28=
29= ## Creating issue/feature request/other
30=
31= To discuss about anything you should create an "issue". To do that, clone and make a file:
32=
33= - `git clone ssh://gitroot.dev/`
34= - `.gitroot/init.sh`
35= - `git checkout -b myIssue`
36= - `open issues/myIssue.md`
37= - write whatever you want in this file. Ideally, include a title and a description representing what you need
38=
39- - `git add . && git commit -m "my issue`
40-
41+ - `git add . && git commit -m "my issue"`
42+
43= - `git push origin myIssue`
44=
45= After that a maintainer will review your branch and merge it into the default branch.
46=
47= These instructions follow the classic [usage](./doc/tutorials/use_instance.md) of any GitRoot instance.
48=
49= ## Adding code
50=
51= To add some code into GitRoot project (called pull-request, merge-request or request-merge) ou need to cindex.mdbranch w a unique namindex.mdush it. , pull the c/anges made by t� rafter plugi`� ��
52
53 is what we c//index.mdft` in Root.
54=
55= Y/index.md link ssue to any /index.mdmoving `issues/issu../index.mdother ectory (`clo../index.mdut ca ange). Revie � structio n the graft � =
56= Gra ile can be f- +- [index.md](../index.md)d`. can only fin0� 0 �� � `� * �� �
57 `� � � P p� b � Grafts do no�� � .** Not all
1= GitRoot is a small yet powerfull git forge. Download one binary, launch it and you have a forge that can :
2=
3= - create git repositories
4= - manage who can access to what repositories
5=
6= Nothing more, nothing less.
7=
8= Install plugins and you will be able to:
9=
10= - create issues, roadmap, sprint, milestone...
11= - represent them in boards
12= - represent them all and many more in a web interface
13=
14= > 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.
15=
16= **Wants more? Build your own plugin!**
17=
18= # Why am I doing this?
19=
20= 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
1= GitRoot is a small yet powerfull git forge. Download one binary, launch it and you have a forge that can :
2=
3= - create git repositories
4= - manage who can access to what repositories
5=
6= Nothing more, nothing less.
7=
8= Install plugins and you will be able to:
9=
10= - create issues, roadmap, sprint, milestone...
11= - represent them in boards
12= - represent them all and many more in a web interface
13=
14= > 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.
15=
16= **Wants more? Build your own plugin!**
17=
18= # Why am I doing this?
19=
20= 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.
21=
22= Every project is unique, so why don't we have the freedom to modify our forge to suit our own project ?
23=
24= So I try to follow these rules when developing my forge:
25=
26= ## As a developer I want:
27=
28= - a repository containing all my data: code, issues, `(pull|merge)-request`, boards
29= - all I need to promote my project: landing page, translation, ticketing, forum
30=
31- - the ability to migrate your project into my server forge: no script migration, no loose data, no loose attribution
32-
33+ - the ability to migrate my project into a new server forge: no script migration, no loose data, no loose attribution
34+
35=
36= > As a developer I want to have a forge crafted for my unique project.
37=
38= ## As a developer I don't want:
39=
40= - to open my browser to manage my data: `(pull|merge)-request`, issues
41= - the first representation of my project is a list of files and directories
42= - my forge chooses my workflow issues: what is a sprint vs a milestone vs an epic vs an user-story?
43= - to have 100 menus to configu ho can do whissues/9422-graft-need-3-review.mdant a complexe ge to manage/my project.
44=
45� As an adminp� �� $ $ = - an easy //issues/9422-graft-need-3-review.mdatabase
46= - onfigure wha/issues/9422-graft-need-3-review.md equest what want: no ne/issues/9422-graft-need-3-review.mdaccess to a p ct or a feat../issues/9422-graft-need-3-review.md a forge th s 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 depe n anyone els/.
47=
48= ### _If � are like me,С � - - ot._
49=
50= It//issues/aa31-graft-mark-falsy-rename-file.mdif give me a ha/issues/aa31-graft-mark-falsy-rename-file.md yti s stored in /issues/aa31-graft-mark-falsy-rename-file.md in git tree. E../issues/aa31-graft-mark-falsy-rename-file.mdco =
51= How can../issues/aa31-graft-mark-falsy-rename-file.md m not? **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 on ne to have a20253005-wording lt branch](.bf56017d278eb4e129030a2abea7e06724d90f7fsomeone tries to pu:ok_hand: review changes and make some others
52if� ions.
53=
1= <!--
2= SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
3=
4= SPDX-License-Identifier: EUPL-1.2
5= -->
6=
7= # Code of Conduct
8=
9= 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).
10=
11= 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.
12=
13= 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.
14=
15= ## Code of Conduct
16=
17= 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.
18=
19= 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.
20=
21= CONTRIBUTING.md= If you experCONTRIBUTING.mda of behaviou/ that goes agai� principles e � @� e of Conduct//CONTRIBUTING.mdt to Romain (cr r of GitRoot/CONTRIBUTING.md ible.
22=
23=
24- P e feel free /CONTRIBUTING.md Conduct wit../CONTRIBUTING.mdonline and off discussions../CONTRIBUTING.mda respectful a elcoming env�� .
25-
26+ se feel free�� e the Co f Conduct wi- +- [CONTRIBUTING.md](../CONTRIBUTING.md)ussion help mainta0� 0 �� � `� * �� �
27 � nment.
28+
29= Ќ �� ngaging in m
1= <!--
2= SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
3=
4= SPDX-License-Identifier: EUPL-1.2
5= -->
6=
7= # Contribution guidelines
8=
9= Any issues or suggestions are welcome at [https://gitroot.dev](htt
Pffffiiiiouuu ça marche pas des masses ça 🤣
Le 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
Est-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 🤷 !!
And this is the first ever graft merged 🎉🎉
Very thank you Damien ❤️
/merge