investments-analyzer

  1. Overview
  2. Project
    1. Project Management
  3. Product
  4. Development
    1. Contributing
    2. Other
  5. Links
  6. Notes
  7. References
  8. License

A template repository

Overview

Some text

Few badges here: discord/gitter/spectrum server, build status (circleci/travis/github-workflow; ghworkflow preferable), code coverage.

build-test-deploy Lint Code Base

[More project metadata badges here. More CI/CD badges here.]

Project

Document Link
Metadata ./documentation/project/metadata.md

Project Management

GitHub Projects

Product

Document Link
Installation ./documentation/product/installation.md
Usage ./documentation/product/usage.md

Development

Document Link
Design and Architecture ./documentation/development/design-architecture.md
Requirements ./documentation/development/requirements.md
Development ./documentation/development/development.md
Testing ./documentation/development/testing.md
CI/CD ./documentation/development/ci-cd.md

Contributing

./.github/CONTRIBUTING.md

Other

Links

Notes

References

License

MIT