DEVELOPING.md 1.5KB
Developing Oragono
Most development happens on the develop branch, which is occasionally rebased + merged into master when it’s not incredibly broken. When this happens, the develop branch is usually pruned until I feel like making ‘unsafe’ changes again.
I may also name the branch develop+feature if I’m developing multiple, or particularly unstable, features.
The intent is to keep master relatively stable.
Updating vendor/
The vendor/ directory holds our dependencies. When we import new pages, we need to update this folder to contain these new deps.
To update this folder:
- Install https://github.com/dpw/vendetta
cdto Oragono foldervendetta -u -p- Commit the result with the message
"vendor: Updated submodules"
This will make sure things stay nice and up-to-date for users.
/vendor on Windows
Vendetta on Windows is broken, keep this in mind while updating deps. For reference, see dpw/vendetta#17.
Fuzzing and Testing
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.
In addition, I’ve got the beginnings of a stress-tester here which is useful: https://github.com/DanielOaks/irc-stress-test
As well, there’s a decent set of ‘tests’ here, which I like to run Oragono through now and then: https://github.com/DanielOaks/irctest