mirror of
https://github.com/GothenburgBitFactory/taskwarrior.git
synced 2025-07-07 20:06:36 +02:00
Docs: Updated dev file
This commit is contained in:
parent
18c8b41f3f
commit
65c351f50e
3 changed files with 29 additions and 267 deletions
59
DEVELOPER
59
DEVELOPER
|
@ -35,9 +35,7 @@ How to Build Taskwarrior
|
|||
General Statement
|
||||
This file is intended to convey the current efforts, priorities and needs of
|
||||
the codebase. It is for anyone looking for a way to start contributing.
|
||||
While this is biased towards developers, anyone can contribute, and everyone
|
||||
is encouraged to do so. Here are many ways to contribute that may not be
|
||||
immediately obvious to you:
|
||||
Here are many ways to contribute that may not be obvious:
|
||||
|
||||
- Use Taskwarrior, become familiar with it, and make suggestions. There are
|
||||
always ongoing discussions about new features and changes to existing
|
||||
|
@ -55,7 +53,7 @@ General Statement
|
|||
so on, and these may contain errors, or they may not convey ideas in the
|
||||
best way. Perhaps you can help improve it. Contact us - documentation is
|
||||
a separate effort from the codebase, and includes all web sites, and all
|
||||
are available using git.
|
||||
are available as git repositories.
|
||||
|
||||
- Take a look at the bug database, and help triage the bug list. This is a
|
||||
review process that involves confirming bugs, providing additional data,
|
||||
|
@ -66,10 +64,10 @@ General Statement
|
|||
- Review the source code, and point out inefficiencies, problems, unreadable
|
||||
functions, bugs and assumptions.
|
||||
|
||||
- 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 work is done well and doesn't create other problems or introduce new
|
||||
dependencies. We recommend talking to us before starting. Seriously.
|
||||
- Fix a bug. For this you'll need C++ and Git skills. We welcome all bug
|
||||
fixes, provided the work is done well and doesn't create other problems or
|
||||
introduce new dependencies. We recommend talking to us before starting.
|
||||
Seriously.
|
||||
|
||||
- Add unit tests. Unit tests are possibly the most useful contributions of
|
||||
all, because they not only improve the quality of the code, but prevent
|
||||
|
@ -88,11 +86,6 @@ General Statement
|
|||
already rejected such a feature for some very good reasons. So please
|
||||
check first, so we don't duplicate effort or waste anyone's time.
|
||||
|
||||
- Donate some server time to the testing effort, by participating in the
|
||||
continuous integration of all changes, with our Flod software. See this
|
||||
page for an example: http://central.tasktools.org. Ask us about running a
|
||||
Flod satellite, we're always looking for exotic platforms to test on.
|
||||
|
||||
- Spread the word. Help others become more effective at managing tasks.
|
||||
|
||||
- Encouragement. Tell us what works for you, and what doesn't. Tell us about
|
||||
|
@ -102,25 +95,6 @@ General Statement
|
|||
missing from the software, but gives us insights into how you use it.
|
||||
Plus, you might get your feature implemented.
|
||||
|
||||
Next are some specific areas that need attention.
|
||||
|
||||
|
||||
New Code Needs
|
||||
This is code that needs to be written.
|
||||
|
||||
- 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
|
||||
properly handle recurring tasks.
|
||||
- Take a look at:
|
||||
|
||||
https://bug.tasktools.org/browse/EX
|
||||
|
||||
This 'extension' release is a collection of all the requested features that
|
||||
lie outside of the core product, and will be implemented as external scripts
|
||||
by anyone who wishes to participate.
|
||||
|
||||
|
||||
Unit Tests Needed
|
||||
There are always more unit tests needed. More specifically, better unit tests
|
||||
are always needed. The convention is that there are four types of unit test:
|
||||
|
@ -150,6 +124,27 @@ Unit Tests Needed
|
|||
|
||||
Note that all new unit tests should follow the test/template.t standard.
|
||||
|
||||
Patches
|
||||
Patches are encouraged and welcomed. Either attach them to the appropriate
|
||||
Jira issue, or send them to support@taskwarrior.org. A good patch:
|
||||
|
||||
- Maintains the MIT license, and does not contain code lifted from other
|
||||
sources. You will have written 100% of the code in the patch, otherwise
|
||||
we cannot maintain the license.
|
||||
- Precisely addresses one issue only.
|
||||
- Doesn't break unit tests.
|
||||
- Doesn't introduce dependencies.
|
||||
- Is accompanied by unit tests, where appropriate.
|
||||
- Is accompanied by documentation changes, where appropriate.
|
||||
- Conforms to the prevailing coding standards - in other words, it should
|
||||
fit right in with the existing code.
|
||||
|
||||
A patch may be rejected for violating any of the above rules, and more.
|
||||
Bad patches may be accepted and modified depending on work load and mood. It
|
||||
is possible that a patch may be rejected because it conflicts in some way with
|
||||
plans or upcoming changes. Check with us first, before sinking time and effort
|
||||
into a patch.
|
||||
|
||||
Current Codebase Condition
|
||||
|
||||
'master' branch:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue