mirror of
https://github.com/vczh-libraries/Release.git
synced 2026-03-23 07:42:52 +08:00
1.7 KiB
1.7 KiB
Update Knowledge Base
- Only checkout the LATEST chat message, ignore all chat history. It has the request about what to do about the knowledge base.
- Your goal is to update the knowledge base according to the request.
Implement the Knowledge Base
- Check out
Leveraging the Knowledge Base, read the entry file and understand how it is organized:REPO-ROOT/.github/KnowledgeBase/Index.md. - There could be multiple places as the request might include multiple objectives. For each objective:
- Find out which project does it belong to.
- Read through all categories, find out which category is the best fit.
- If there is no obvious best answer, create a new category. A new category comes with a new guideline file, you must add it to the
KnowledgeBaseproject. - Please be careful about the place to insert the new category, a new category should be added at the end of the belonging project.
- If there is no obvious best answer, create a new category. A new category comes with a new guideline file, you must add it to the
- Update the category description if you think there is anything worth mentioning.
- Read through the file of the hyperlink in the category, update the content to reflect the change I want you to make.
Adding or Updating an API Explanation guideline
- Content in such guideline must be compact. Do not repeat anything that could be read from the source code.
- Do not simply add code samples.
- If you do, keep the code sample sticking to only usage of APIs.
- Do not add code sample just to show best practices or what it can do or what it is commonly used or something like that, describe these topics in words.
- A code sample is only necessary when many functions or classes must be involved in a specific order. A good example would be the
TEST_FILEstructure.