yan/rvs-prxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
rvs-prxy/Design_Doc/instructions2AI.md

1.5 KiB
Raw Permalink Blame History

Before Starting Any Work

  • Please read the following documents carefully before taking any actions on this project: README.md, Design_Doc/Spec.md, Design_Doc/Operations.md and Design_Doc/Tech_Desc.md. These files provide essential background information and project understanding. Only after reviewing them should you proceed with the following tasks.

Your Current Tasks

  • Listing the specific tasks for this session.

Quick Reminder: Update the Documents After You Change the Code

Whenever you finish making code changes, please take a few minutes to update the related documents.
This keeps everything clear and up-to-date for everyone on the team.

Which files might need an update?

Only touch the files that your changes actually affect. The most common ones are:

  • README.md
  • Design_Doc/Spec.md
  • Design_Doc/Operations.md
  • Design_Doc/Tech_Desc.md

How should you update them?

Just follow the style and purpose each file already has. (You can check the "Documentation Overview" part in README.md if you're not sure.)

BACKUP before you touch the above mentioned documents:

  • you make a doc. backup folder Design_Doc/bck/ if not exist, then before any your touch of documents, such as: Design_Doc/Tech_Desc.md, you copy that current version into eg. Design_Doc/bck/Design_Doc/Tech_Desc_YYYYMMDDHHMMSS.md. The other document files as same approach by keeping the path and file name with Date and Time at file name into backup folder.