README.md

Backend Team Way of Work

The purpose of this document is to works as a resource for any developer working with the DHIS 2 source code.

Table of contents

1. Using this document
2. Contributing
3. Guides
4. Coordination

Using this document

This document is split into multiple files, all written in markdown. There is two ways to navigate the repository:

• Using the file-browser, find the topic you are looking for.
• Using the links from this document, navigate from topic to topic.

Contributing

Guides are placed in the /guides directory. Start guides with the # h1 header, then use subsequent header numbering (## h2, and so on). Coordination pages are placed in the /coordination directory.

Guides

The following section lists guides on various topics.

Collaboration

• Flyway database migration
• Component owners
• Git PR & commit messages
• Git pull requests

General Coding

• Code Best Practices and Conventions
• OpenAPI
• Code formatting

Running

• Embedded Jetty API build
• IDEA and Tomcat setup (includes hot swapping)
• Monitoring
• Ubuntu Linux Android app mirroring

Testing

• API testing
• Spring controller testing
• Test mocking with Mockito
• Testing

Database

• JPA and database functions
• JPA queries
• New database table Flyway migration
• PostgreSQL JSONB
• PostgreSQL commands
• PostgreSQL read replica

Coordination

The following section lists various areas of coordination.

• Flyway versioning

Developer documentation

The following pages contain high-level developer documentation for various solutions.

• Job scheduling
• Data value set import/export
• Auditing

Talks

The following pages are slides used in talks from Thursday meetings:

• JSON stream processing (html slides)
• PEG parsers (html slides)
• Reflection, generics & type erasure (html slides)