From a94893674053777bb0aad45a9c7c1af69faa12fe Mon Sep 17 00:00:00 2001 From: Marius Kintel Date: Sat, 1 Feb 2014 13:43:58 -0500 Subject: [PATCH] Started on hacking doc --- doc/TODO.txt | 2 -- doc/hacking.txt | 11 +++++++++++ 2 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 doc/hacking.txt diff --git a/doc/TODO.txt b/doc/TODO.txt index e56dbd74..46b7b119 100644 --- a/doc/TODO.txt +++ b/doc/TODO.txt @@ -226,8 +226,6 @@ o Visitation refactoring DOCUMENTATION ------------- o Auto-generate API documentation instead of, in addition to or combined with, the wikibooks docs. -o Write checklists for typical extension work (add new module, add new function) - -> syntax highlighter, test files, examples, documentation (external editor modes) o Clarify include/use better in the wikibook docs (e.g. that use'd modules have to be self-contained) TESTING diff --git a/doc/hacking.txt b/doc/hacking.txt new file mode 100644 index 00000000..ad16f99c --- /dev/null +++ b/doc/hacking.txt @@ -0,0 +1,11 @@ +# Add new function/module + +* Implement +* Add test +* Modules: Add example +* Document: + * wikibooks + * cheatsheet + * Modules: tooltips (editor.cc) + * External editor modes + * Add to RELEASE_NOTES