Skip to content

Commit c9b527a

Browse files
author
Pavelka, Roman (ADV D EU CZ PDS1 CIO 1)
committed
Add definiton as done
1 parent 82f3882 commit c9b527a

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

definition-of-done.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Definition of Done
2+
3+
A "Definition of Done" (DoD) provides a shared understanding among the team about
4+
what it means for work to be complete. This is pretty exhausting list and should
5+
be tailored to your specific needs.
6+
7+
## Code:
8+
9+
* Code is written according to the team's coding standards.
10+
* Code is reviewed and any identified issues are addressed. (See [code review guidelines](README.md))
11+
* Code is checked into the version control system with a meaningful commit messages.
12+
* Code is accompanied by appropriate comments and documentation.
13+
* Dependencies (e.g., libraries, tools) are properly managed and documented.
14+
* All warnings and errors generated by the compiler are addressed.
15+
* Unused code, debug code, and commented-out code have been removed.
16+
17+
## Testing:
18+
19+
* Unit tests are written for all new functionality and changes.
20+
* All unit tests pass successfully.
21+
* Code coverage meets or exceeds the team's agreed-upon threshold.
22+
- Integration tests are conducted and pass successfully.
23+
* Performance tests, if applicable, meet required benchmarks.
24+
* Regression tests have been run and any regressions addressed.
25+
* Hardware-in-the-loop testing (if applicable) has been performed and passed.
26+
27+
## Documentation:
28+
29+
* Inline documentation is up to date.
30+
* External documentation, like user manuals or system specs, is updated as needed.
31+
* API documentation (if applicable) is generated and accurate.
32+
33+
## Security:
34+
35+
* Code has undergone security review.
36+
* Known vulnerabilities are addressed.
37+
* Security tests have been conducted and passed.
38+
39+
## Integration:
40+
41+
* Changes are integrated into the main branch and do not break the build.
42+
* Integration with external systems/interfaces has been tested.
43+
* Firmware can be successfully built and deployed to target hardware.
44+
45+
## Non-Functional Requirements:
46+
47+
* The product meets all agreed-upon non-functional requirements (e.g., performance, reliability, usability).
48+
49+
## Review:
50+
51+
* Product Owner (or designated stakeholder) has reviewed the functionality and accepted it.
52+
* Feedback from demos, if any, has been addressed.
53+
54+
## Miscellaneous:
55+
56+
* All known defects and issues are documented in the backlog.
57+
* Any necessary configurations or settings have been documented.
58+
* All code and changes are traceable to associated requirements or user stories.

0 commit comments

Comments
 (0)