Browse Source

developing: Add instructions for updating vendor/

tags/v0.7.0
Daniel Oaks 7 years ago
parent
commit
1b92f9e93f
1 changed files with 14 additions and 0 deletions
  1. 14
    0
      DEVELOPING.md

+ 14
- 0
DEVELOPING.md View File

@@ -7,6 +7,20 @@ I may also name the branch `develop+feature` if I'm developing multiple, or part
7 7
 The intent is to keep `master` relatively stable.
8 8
 
9 9
 
10
+## Updating `vendor/`
11
+
12
+The `vendor/` directory holds our dependencies. When we import new pages, we need to update this folder to contain these new deps.
13
+
14
+To update this folder:
15
+
16
+1. Install https://github.com/dpw/vendetta
17
+2. `cd` to Oragono folder
18
+3. `vendetta -u -p`
19
+4. Commit the result with the message `"vendor: Updated submodules"`
20
+
21
+This will make sure things stay nice and up-to-date for users.
22
+
23
+
10 24
 ## Fuzzing and Testing
11 25
 
12 26
 Fuzzing can be useful. We don't have testing done inside the IRCd itself, but this fuzzer I've written works alright and has helped shake out various bugs: [irc_fuzz.py](https://gist.github.com/DanielOaks/63ae611039cdf591dfa4).

Loading…
Cancel
Save