Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 1.89 KB
Raw

Contributions in English

Using Bold

  • to note step numbers.
    • Example: First, Second, Third, etc
  • to designate important Creator Components, Objets, UI Elements.
    • Example: Scene, Sprite inspector, Sprite inspector, Asset panel or Asset panel

List items

  • Example: apple, orange, banana, and pear
  • Example:
    • apple
    • orange
    • pear

Using a single backtick (code wrapper)

  • designate class names, property names and function names.
    • Example: SpriteComponent, onEnable, SpriteComponent.spriteFrame
  • filenames and paths.
    • Example: myfile.txt, /mypath/myfile.txt, /assets/xyz/

Using a triple backtick

  • code blocks

Tables

Can bold or italics the first colume but bot the second column. Examples:

Properties Explanation
anisotropy Anisotropy value
minFilter Narrowing Filter Algorithm
Properties Explanation
anisotropy Anisotropy value
minFilter Narrowing Filter Algorithm
Properties Explanation
anisotropy Anisotropy value
minFilter Narrowing Filter Algorithm

Grammar suggestions

  • Firstly -> First.
  • At present, —> Currently,
  • Cocos Creator —> Cocos Creator (let's bold our product name
  • Note: —> > Note:
  • Related Reference Links —> Reference documentation
  • do not use phrases like: "Now let me explain", "he should do this"
  • text like this should be avoided: "If you have never written a program and don’t worry, we will provide all the required code in the tutorial, just copy and paste it to the correct location, and then you can find your programmer partner to solve this part of the work. Let's start creating the script that drives the main character's actions."

Technical designations

  • json -> JSON
  • js or JS -> JavaScript
  • ts or TS -> TypeScript