Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ISC Open Source Projects
BIND
Commits
bdc60a0b
Commit
bdc60a0b
authored
Nov 24, 2015
by
Evan Hunt
Browse files
[master] update developer guide, expanding on comments and unit tests
parent
447591a4
Changes
1
Hide whitespace changes
Inline
Side-by-side
doc/markdown/dev.mkd
View file @
bdc60a0b
...
...
@@ -61,12 +61,19 @@ practices. Third, the contribution is checked for correctness and
completness.
Obvious bottlenecks and places where performance or reliability may suffer
are noted as part of the review. Tricky code needs to be commented well
enough. A patch is much more likely to be accepted quickly if it includes
are noted as part of the review.
New functions must be adequately commented. Public API functions are
documented in the corresponding header file, static functions in the C
file, above the function header. Particularly complex code should be
commented throughout the function body as well.
A patch is much more likely to be accepted quickly if it includes
tests providing good coverage of the new code. Tests for bugfix code
should fail when run against the unmodified code; tests for new feature
code should have good code coverage and address corner cases and error
cases. (See
[
testing
](
#testing
)
.)
cases. Newly added API functions should have unit tests if possible.
(See
[
testing
](
#testing
)
.)
Documentation is also reviewed. This includes all user-facing text,
including log messages, manual pages, user manuals and sometimes even
...
...
@@ -249,6 +256,9 @@ redirected:
Information on writing ATF tests can be found at the
[
NetBSD site
](
http://wiki.netbsd.org/tutorials/atf/
)
.
New unit tests should be added whenever significant new API
functionality is added to libdns or libisc.
Each unit test file contains at least one unit test case, and
a list of test cases to execute when the test is run. These
will look like the following:
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment