croz-ltd / nrich-demo-backend Goto Github PK

Basic information

Add GitHub badges to main README.md.

Additional information

See nrich for example.

Enhancement description

Add badges for the "build" GitHub Action, for the open source license and for codecov.

Current behaviour

No GitHub badges in main README.md.

Wanted behaviour

GitHub badges added to main README.md.

Possible workarounds

Basic information

A main GitHub Action for building the project is needed.

Additional information

See nrich for an example script.

Enhancement description

The script should build the app on all 3 major operating systems (it's important to run tests, but clean build is the recommended command).

Current behaviour

No GitHub action present.

Wanted behaviour

Main "build" GitHub action present.

Possible workarounds

Basic information

Add missing GitHub templates/items in the Community Standards.

Additional information

Take a look at the configured templates in nrich and add them analogously.

Enhancement description

Add missing GitHub templates/items in the Community Standards when the project becomes public.

• Code of conduct
• Contributing guidelines
• Issue templates
• Pull Request template
• other?

Current behaviour

There are missing GitHub templates in the Community Standards.

Wanted behaviour

There are no missing items in the GitHub Community Standards.

Possible workarounds

Basic information

Add open source license to GitHub project.

Additional information

See nrich for example. There, we used Apache License 2.0, so, we suggest using it here as well.

Enhancement description

Add open source license to GitHub project before it becomes public.

Current behaviour

No open source license present.

Wanted behaviour

Open source license applied.

Possible workarounds

Basic information

Define branch protection and pull request rules after the repo becomes public.

Additional information

Configure same settings as in nrich.

Enhancement description

Define and add

• branch protection rules
• pull request rules (rebasing, build has to pass, min. 1 approval etc.)

Current behaviour

No branch protection nor pull request rules present.

Wanted behaviour

Branch protection and pull request rules present.

Possible workarounds

Basic information

Add licence header to all source files

Additional information

Enhancement description

At the moment, source files don't contain licence header, take a look at e.g. Spring where it's present.

Current behaviour

There are no licence headers in any source files.

Wanted behaviour

There should be same licence header in all source files.

Possible workarounds

Basic information

Add code coverage integration with codecov.io.

Additional information

See nrich for example.

Enhancement description

Add code coverage integration with codecov.io so we can have a graphic representation of the code coverage. Add test report generation and publishing to the main "build" GitHub Action.

Current behaviour

No integration with codecov.io.

Wanted behaviour

Integration with codecov.io present.

Possible workarounds

Basic information

Add ADR template and decisions.

Additional information

See nrich for example.

Enhancement description

We would like a way of tracking our architecture decisions in the project as to make onboarding of new developers easier
and keep track of important changes inside the project.

Current behaviour

No explanation of the current architecture exists.

Wanted behaviour

A list of architecture decision records exists explaining the current state of project. All future decisions are also recorded.

Possible workarounds