Branch Naming Conventions; Q&A Guidelines - Espressif Systems ESP Faq

Chapter 1. Instruction
git status #To see the status of your current branch
git checkout -b add/artificial-intelligence_camera_model #To add new
about "artificial-intelligence camera model"
→

1.2.3 Branch naming conventions

• Add a new item: add/artificial-intelligence_{q&a}, {q&a} is the brief English name of the
file. For example, if you expect to add a new item as artificial intelligence camera model,
then the branch name should be: add/artificial-intelligence_camera_model.
• Modify contents: mod/artificial-intelligence_q&a, q&a is the brief English name of the file.
For example, if you expect to modify the contents about artificial intelligence camera model,
then the branch name should be: mod/artificial-intelligence_camera_model.
1.2.4 Q&A Guidelines
Please add new Q&A items and do updates according to the guidelines as follows:
General guideline:
• If you are going to add a new Q&A item, always remember to add a separate line after the previous one as "
——————-".
For questions:
• Illustrate questions clearly, for example:
– When flashing firmware to ESP32-S2, an error occurred as "A fatal error occurred: Invalid head of
packet (0x50)"? (NOT Clear)
– When flashing firmware to ESP32-S2, an error occurred as "A fatal error occurred: Invalid head of
packet (0x50)". How to resolve such issue? (Preferable)
• Do not make the question too long. If this is the case, extract the main question as the title and describe the
background and details below.
For answers:
• If there will be code in the text, use code box to separate it with the main text.
• If an answer only includes one sentence, there is no need to write a list, just use a regular paragraph.
• Use lists to separate items or to enumerate sequential items:
– Use numbered lists for items that are in a required order (such as step-by-step instructions) or for items
that are referred to by item number.
– Use bulleted lists for items that are in no required order.
• Provide introductory phrase before a list to indicate the meaning or purpose of the list, and place a colon ":"
at the end of it.
• If two items are alternatives, use a bullet list (not numbered list) and indicate their relationship in the introduc-
tory phrase.
• Always add two spaces before an listed item or paragraph in the answer.
• When a separate notice or explanatory paragraph follows a item, indent that separate material to the text of the
parent list item.
• Follow list punctuation rules described in
For additional guidance regarding list please refer to
for text and figures below.
Q&A example
--------------
Does Espressif have any AI image recognition products?
Espressif Systems
Espressif Manual of
Bulleted and Numbered
5
Submit Document Feedback
contents␣
Style, Section Punctuation in Lists.
Lists. Please see the example template
(continues on next page)
Release master