/ CONTRIBUTING.md
CONTRIBUTING.md
 1  # Contributing
 2  
 3  You must have [`quilt`](https://savannah.nongnu.org/projects/quilt) to work with patches.
 4  
 5  ## Quick Start
 6  
 7  ```sh
 8  # clone fiak with yaak submodule
 9  git clone --recurse-submodules https://github.com/Vexcited/Fiak
10  
11  # or the following if your forgot the clone with submodules...
12  git submodule update --init --recursive
13  
14  # apply all patches
15  quilt push -a
16  ```
17  
18  Follow instructions in [`yaak/DEVELOPMENT.md`](./yaak/DEVELOPMENT.md) if you want to build Fiak locally.
19  
20  ## Updating upstream
21  
22  ```sh
23  # remove all patches
24  quilt pop -af
25  
26  # update upstream to a given version
27  cd yaak
28  git fetch --tags
29  git checkout v2025.9.3 # for example
30  cd ..
31  
32  # commit the new pointer
33  git add yaak
34  git commit -m 'chore(yaak): upgrade to v2025.9.3'
35  
36  # apply all patches
37  quilt push -af
38  ```
39  
40  Pray there's no conflict, if that's the case,
41  resolve them through `refresh` and `push`.