search

InKCre / .github

document of InKCreThing
Creative Commons Attribution Share Alike 4.0 International
0 stars 0 forks source link

Coding standard #7

Closed xiaoland closed 7 months ago

xiaoland commented 8 months ago

Honestly, "coding standard" is not accurate enough to describe what it contains... We will establish a series of standards for coding style, naming, reusability, readability, testing ... etc.

But our aim is clear:

  1. make code more readable
  2. make code easier to extend
  3. make code easier to maintain(debug, adjust)
  4. make code easier to test (That's not all, but enough for now)

And we are going to have these standards:

  1. coding for readability
  2. coding for reusability, expandability

Will be published in coding-standard.md

xiaoland commented 7 months ago

Breaking down the targets, what we should clarify or make?

  1. Naming rules
  2. Environment Configure