Verified Commit f287d34f authored by 35V LG84's avatar 35V LG84
Browse files

Clean up development documentation


Signed-off-by: 35V LG84's avatar35V LG84 <35vlg84-x4e6b92@e257.fi>
parent 0b47bfcb
Pipeline #44359478 passed with stage
in 4 minutes and 41 seconds
......@@ -6,9 +6,16 @@ Contributions to the project are most welcome!
== Open and planned tasks
At the moment project todo items are maintained in link:../todo/[todo files].
Before starting working on something, please first check with Gitlab issue
Before starting working on something, please first check by opening Gitlab issue
if your plan is feasible and viable from project's perspective.
=== Tackler Enhancements Proposals
Bigger changes to Tackler are done via Tackler Enhancements Proposals.
These are tracked on link:./docs/tep/readme.adoc[TEP Index]. There is template
for new TEP here: link:./docs/tep/tep-0001.adoc[TEP template]
== How to build and test
......@@ -29,6 +36,12 @@ if your plan is feasible and viable from project's perspective.
sbt clean coverageOn test coverageReport
sbt coverageAggregate
== Documentation for Tackler developers
link:./docs/devel/readme.adoc[Developer's Guide] for Tackler located under
link:./docs/devel/[docs -> devel].
== Explore code
Directory structure follows Maven's layout and code has been divided to sub-projects
......@@ -52,9 +65,9 @@ link:./cli[cli]::
* link:./cli/src/main/scala/fi/e257/tackler/cli/[cli -> scala -> cli] Command Line Interface code
+
link:./tests[tests]::
link:https://github.com/sn127/utils[DirSuite] based integration tests for Tackler.
This directory contains link:https://github.com/sn127/utils[DirSuite] based integration tests for Tackler.
+
** link:./tests/tests.yaml[tests -> tests.yaml] List of all tests and tested features
** link:./tests/tests.adoc[tests -> tests.adoc] General overview of tests and Tackler Test Tracking Database (T3DB)
** link:./tests/accumulator[tests -> accumulator] Tests for validating calculator and Accumulator operations
** link:./tests/cli[tests -> cli] Tests for Command Line Interface verification
** link:./tests/parser[tests -> parser] Parser and input recognition tests (valid and non-valid input)
......@@ -64,7 +77,11 @@ link:https://github.com/sn127/utils[DirSuite] based integration tests for Tackle
=== API documents
Also see link:docs/devel/readme.adoc[developer's documentation] and link:./docs/server-api.adoc[Server API] and link:./docs/client-api.adoc[Client API].
For API documents, see:
* link:./docs/devel/readme.adoc[Developer's Guide]
* link:./docs/server-api.adoc[Server API]
* link:./docs/client-api.adoc[Client API].
== Developer Certificate of Origin
......
commit 7a3d8df7e88c871416633970009154ab1d6d341b
[info] Statement coverage.: 94.76%
[info] Branch coverage....: 93.94%
[info] Coverage reports completed
[info] Aggregation complete. Coverage was [94.76]
commit 5ef243236b6406b4fee0b11be0ae08460467b963
[info] Statement coverage.: 99.36%
[info] Branch coverage....: 100.00%
[info] Coverage reports completed
[info] Aggregation complete. Coverage was [99.36]
commit e18b12294f20c5d89827bf749c836945fbaaf380
[info] Statement coverage.: 99.37%
[info] Branch coverage....: 100.00%
[info] Coverage reports completed
[info] Aggregation complete. Coverage was [99.37]
commit 60a533a44859a7f738b5cfc14b5e690ef27c67f4
[info] Statement coverage.: 94.26%
[info] Branch coverage....: 83.33%
[info] Coverage reports completed
[info] Aggregation complete. Coverage was [94.26]
commit 21bed83c04e33fb6a6a7112cf09cfc490adad327
[info] Statement coverage.: 99.53%
[info] Branch coverage....: 100.00%
[info] Coverage reports completed
[info] Aggregation complete. Coverage was [99.53]
commit 2bbc88de3fec3b1a7cd5beee5863814e17c3f7d7
[info] Statement coverage.: 99.54%
[info] Branch coverage....: 100.00%
[info] Coverage reports completed
[info] Aggregation complete. Coverage was [99.54]
commit 1c752af60bc938677b476f8d700008c26ecb6dd5
[info] Statement coverage.: 99.68%
[info] Branch coverage....: 100.00%
[info] Coverage reports completed
[info] Aggregation complete. Coverage was [99.68]
[info] All done. Coverage was [99.68%]
commit a8ae71b56f5362aa28fac98826c23d538528b9ee
[info] Statement coverage.: 99.21%
[info] Branch coverage....: 100.00%
[info] Coverage reports completed
[info] Aggregation complete. Coverage was [99.21]
[info] All done. Coverage was [99.21%]
commit bae603d6288b4c3acfaaad3d39884422c4e8b93c
[info] Statement coverage.: 99.70%
[info] Branch coverage....: 100.00%
[info] Coverage reports completed
[info] Aggregation complete. Coverage was [99.70]
[info] All done. Coverage was [99.70%]
......@@ -16,7 +16,13 @@ For example Txn (single Transaction) or Txns (sequence of Transactions).
In case of tree-structures, child (singular) and childs (plural) is misspelled by purpose.
Tackler data model classes and objects are defined in link:../../core/src/main/scala/fi/e257/tackler/model[core / model] package.
Tackler data model classes and objects are defined in
link:../../core/src/main/scala/fi/e257/tackler/model[core / model] package.
Tackler data model classes which are used between server and client are located in
link:../../api/src/main/scala/fi/e257/tackler/api/[tackler-api] package. These API models
are serialized over wire by Circe as JSON, and there are deserializers available
as JavaScript and JVM for these models.
===== Date
......
......@@ -13,6 +13,8 @@ TEP Template: link:./tep-0001.adoc[TEP-0001]
* link:./tep-1002.adoc[TEP-1002: Git Storage system]
* link:./tep-1004.adoc[TEP-1004: JSON report output]
* link:./tep-1005.adoc[TEP-1005: Txn filters]
* link:./tep-1006.adoc[TEP-1006: CFG settings for report output scale]
=== TEPs in implementation phase
......@@ -21,5 +23,3 @@ None at the moment
=== TEPs in planning phase
* link:./tep-1003.adoc[TEP-1003: Profit and Loss (PnL)]
......@@ -109,8 +109,13 @@ Changes to identity export
== Documentation
* [ ] link:./readme.adoc[]: Update TEP index
* [ ] link:../../README.adoc[]: is it a new noteworthy feature?
* [ ] link:../../CHANGELOG[]: add new item
* [ ] Does it warrant own T3DB file?
** [ ] update link:../../tests/tests.adoc[]
** [ ] update link:../../tests/check-tests.sh[]
** [ ] Add new T3DB file link:../../tests/tests-XXXX.yml[]
* [ ] User docs
** [ ] user manual
*** [ ] cli-arguments
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment