Documentation: Updated for 2.4.5/2.5.0

This commit is contained in:
Paul Beckingham 2015-07-24 18:49:21 -04:00
parent 564a84d603
commit 61a9eec512
3 changed files with 25 additions and 75 deletions

View file

@ -10,7 +10,7 @@ How to Build Taskwarrior
Obtain and build code:
$ git clone https://git.tasktools.org/scm/tm/task.git task.git
$ cd task.git
$ git checkout 2.4.4 # Latest dev branch
$ git checkout 2.4.5 # Latest dev branch
$ cmake -DCMAKE_BUILD_TYPE=debug . # debug or release. Default: neither.
$ make VERBOSE=1 # Shows details
@ -18,7 +18,6 @@ How to Build Taskwarrior
$ cd tests
$ make VERBOSE=1 # Shows details
$ ./run_all # Runs all tests silently > all.log
# Install 'vramsteg' for blinkenlights
$ ./problems # Enumerate test failures in all.log
Note that any development should be performed using a git clone, and the
@ -72,8 +71,7 @@ General Statement
all, because they not only improve the quality of the code, but prevent
future regressions, therefore maintaining quality of subsequent releases.
Plus, broken tests are a great motivator for us to fix the causal defect.
You'll need Python skills, as we are migrating from Perl to Python for our
test suite.
You'll need Python skills.
- Add a feature. Well, let's be very clear about this: adding a feature is
not usually well-received, and if you add a feature and send a patch, it
@ -102,21 +100,9 @@ General Statement
Next are some specific areas that need attention.
Deprecated Code
This is code that is going to be phased out soon, and therefore is not worth
fixing or documenting. Don't waste your time.
- Nag feature.
- Attribute modifiers.
New Code Needs
This is code that needs to be written.
- Need export_viz.* script. Any language. This would have value as an example
or template script serving as a starting-point for anyone who needed this
format.
- Need new export_xxx.* scripts - the more the better. Any language.
- Need an external script that can locate and correct duplicate UUIDs in the
data file, as found by 'task diag'. This should check to see if there is
a suitable UUID generator installed. This should also be careful to
@ -148,28 +134,17 @@ Unit Tests Needed
these kind of tests be extensive and thorough, because the software depends
on this code the most.
The tests are mainly written in Perl, and all use TAP. We are replacing these
with Python equivalents, so we are now only accepting new tests that use the
Python-test framework.
The tests are written in Python, and all use TAP.
Tests needed:
- Take a look at the bug database (https://bug.tasktools.org) and notice that
many issues, open and closed, have the "needsTest" label. These are things
that we would like to see in the test suite, as regression tests.
- The basic.t unit tests are a misnomer, and should be either removed or
renamed. We have long talked of 'basic functionality' that includes add,
delete, done, and list commands. We need unit tests that prove that basic
functionality is working, and the file containing them should be called
basic.t.
- Test propagation of modifications to recurring tasks.
- Test regex support.
- Need unit tests for each bug in the issue list that is marked with the
'needsTest' label.
Note that running the unit tests currently requires the Perl JSON module to
be installed. This will change soon.
Note that all new unit tests should follow the test/template.t standard.
Work in Progress
@ -190,4 +165,4 @@ Current Codebase Condition
---
2015-07-11 Updated for 2.4.5
2015-07-24 Updated for 2.4.5