gergely/taskwarrior-2.x
1
0
Fork 0
Code Issues Actions Packages Projects Releases 1 Wiki Activity

Documentation

Browse Source 
- Fix some typos in developer files.
- Add information on grid testing with flod.
This commit is contained in:
Scott Kostyshak
2012-12-22 07:27:20 -05:00
committed by Paul Beckingham
parent 144ca70a36
commit 745d24e124
2 changed files with 22 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
DEVELOPER
View File

@@ -19,11 +19,11 @@ General Statement
- Take a look at the bug database. It is the nature of software to contain - Take a look at the bug database. It is the nature of software to contain
bugs, and there is a continuous effort to fix them. Looking at open bugs bugs, and there is a continuous effort to fix them. Looking at open bugs
and confirming them, perhaps determining that it is already fixed, or just and confirming them, perhaps determining that they are already fixed, or
adding clarifying information are all very useful contributions and much just adding clarifying information are all very useful contributions and
needed. much needed.
- Fix a bug. For this you'll need C++ and git skills, but this is one of - Fix a bug. For this you'll need C++ and Git skills, but this is one of
the largest ways you can contribute. We welcome all bug fixes, provided the largest ways you can contribute. We welcome all bug fixes, provided
the work is done well and doesn't create other problems or introduce new the work is done well and doesn't create other problems or introduce new
dependencies. dependencies.
@@ -46,7 +46,8 @@ General Statement
- Spread the word. Help others become more effective at managing tasks. - Spread the word. Help others become more effective at managing tasks.
- Encouragement. Tell us what works for you, and what doesn't. It's all good. - Encouragement. Tell us what works for you, and what doesn't. It's all
good.
Following are specific areas that could use some attention. Following are specific areas that could use some attention.
@@ -138,7 +139,7 @@ Unit Tests Needed
make test make test
Either way, a TAP file 'all.log' is written that contains all test results. Either way, a TAP file 'all.log' is written that contains all test results.
once this file is created, you can see the failing tests using this script: Once this file is created, you can see the failing tests using this script:
cd task.git/test cd task.git/test
./problems ./problems
@@ -153,7 +154,8 @@ Unit Tests Needed
- The basic.t unit tests are a misnomer, and should be either removed or - 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, renamed. We have long talked of 'basic functionality' that includes add,
delete, done, and list commands. We need unit tests that prove that basic delete, done, and list commands. We need unit tests that prove that basic
functionality is working, and it should be called basic.t. functionality is working, and the file containing them should be called
basic.t.
- None of the current unit tests remove the 'extensions' directory, and they - None of the current unit tests remove the 'extensions' directory, and they
all should. all should.
- Test propagation of modifications to recurring tasks. - Test propagation of modifications to recurring tasks.
@@ -161,9 +163,9 @@ Unit Tests Needed
- Need unit tests for each bug in the issue list, if suitable. - Need unit tests for each bug in the issue list, if suitable.
- We have bugs in the unit tests that only manifest on days such as December - We have bugs in the unit tests that only manifest on days such as December
31st. Clearly there is some bad date math going on, most likely in the 31st. Clearly there is some bad date math going on, most likely in the
tests themselves, rather than in taskwarrior. tests themselves, rather than in Taskwarrior.
* Note that running the unit tests require the Perl JSON module to be * Note that running the unit tests requires the Perl JSON module to be
installed. installed.
Work in Progress Work in Progress

17
EXPOSITION
View File

@@ -156,12 +156,11 @@ Test Suite
There are currently over 5,000 unit tests, that take a minute or two to run There are currently over 5,000 unit tests, that take a minute or two to run
in total. in total.
There is a tinderbox that runs on a variable frequency. As a release Taskwarrior uses flod software to automate continuous integration across
approaches, the frequency is boosted so there are always current results to be many platforms. Code changes are automatically detected, propagated, built and
found. Between releases the tinderbox runs daily. It is intended that this tested on a variety of participating platforms. Grid testing results are here:
be modified for continuous integration, so it runs once per commit.
http://tasktools.org/tinderbox/task.html http://tasktools.org/tinderbox/taskwarrior.html
When making code changes, it is important that the test suite be run to verify When making code changes, it is important that the test suite be run to verify
that functionality was not broken. that functionality was not broken.
@@ -193,9 +192,9 @@ Patches
- Conforms to the prevailing coding standards - in other words, it should - Conforms to the prevailing coding standards - in other words, it should
fit right in with the existing code. fit right in with the existing code.
A patch may be rejected for any of the above reasons, and more. Bad patches A patch may be rejected for not following the above guidelines, and more.
may be accepted and modified depending on work load and mood. It is possible Bad patches may be accepted and modified depending on work load and mood. It
that a patch may be rejected because it conflicts in some way with plans or is possible that a patch may be rejected because it conflicts in some way with
upcoming changes. plans or upcoming changes.
--- ---