011-My simple repository template (javascript / typescript)

01 - Story / Idea / Background / Why ?

I want to illustrate my software project handling.

To my self-driven-project. It means/consists 3 main parts to me. They are (equally weighted): code, test, documentation.

02 - Demo repository (private)

https://github.com/louiscklaw/admin_demo11

03 - Explaination

this is the current directory list of my project:

.
├── 001_documentation
├── 002_docker
├── 003_src
├── 004_scripts
├── 005_tickets
├── 008_e2e
├── 010_operations
├── 011_log_and_history
├── 099_prompts
├── AGENTS.md
└── README.md

code (002_docker, 003_src,099_prompts)

• implementation (003_src) code is the actual implementation and it consists

  • actual source code
  • linting (if applicable)
  • unittest (if applicable)
  • formatting

• operation (002_docker,010_operations) handle the operation of the code (most likely it is a docker container)

test (008_e2e)

Automatic testing and Manual testing co-ops each other. For some reason there is lacking of testing equipment. Manual testing should be intercepted. For some reason the test-stand(a.k.a. setup) is not dedicated. Manual testing with scripting may be a better choice.

With testing automation. I always chase a common-reference-point. It is a point(or a method) from ground-up that can assure the fault symptom can be sysmatically-reproduced. Pick a firmware testing for example.

• A fresh flashed firmware without custom configuration is a good reference point.
• A fresh flashed with consistant configuration/steps is a good reference point.

Try to avoid the randomness is the main idea.

• auto testing / manual testing
  • test code (automation)
  • e2e test (if applicable, e.g. playwright, appium)
  • rendering (if applicable, e.g. cypress)
  • smoke / sanity (if applicable)
  • happy-touring

documentation (001_documentation, 005_tickets,011_log_and_history)

• tickets / trackers (005_tickets)

  • handle and breakdown Product Requirement Specification (PRD, PRS) into feature ticket
  • bug trackers
    • bugs ticket
  • improvement/enhancement trackers
    • feature ticket

• documentation webpage (001_documentation)

  • Usually i will draft a documentation webpage to handle it (pretty simple even from the docusaurus default template).
  • Try to minize the time wasted when the official documentation is required.