Browse Source

refering to good practices

content-update
lee 5 years ago
parent
commit
323ae83b5d
  1. 2
      subjects/ascii-art-reverse.en.md
  2. 2
      subjects/ascii-color.en.md
  3. 2
      subjects/ascii-fs.en.md
  4. 2
      subjects/ascii-justify.en.md
  5. 2
      subjects/ascii-output.en.md
  6. 28
      subjects/good-practices.en.md

2
subjects/ascii-art-reverse.en.md

@ -20,7 +20,7 @@ This project will help you learn about :
### Instructions
- Your project must be written in **Go**.
- The code must respect the **good practices**.
- The code must respect the [**good practices**](https://github.com/01-edu/public/good-practices.en.md).
- It is recommended that the code should present a **test file**.
### Usage

2
subjects/ascii-color.en.md

@ -21,6 +21,6 @@ This project will help you learn about :
### Instructions
- Your project must be written in **Go**.
- The code must respect the **good practices**.
- The code must respect the [**good practices**](https://github.com/01-edu/public/good-practices.en.md).
- It is recommended that the code should present a **test file**.
- You may use the same `banner` file.

2
subjects/ascii-fs.en.md

@ -16,7 +16,7 @@ This project will help you learn about :
### Instructions
- Your project must be written in **Go**.
- The code must respect the **good practices**.
- The code must respect the [**good practices**](https://github.com/01-edu/public/good-practices.en.md).
- It is recommended that the code should present a **test file**.
### Usage

2
subjects/ascii-justify.en.md

@ -21,7 +21,7 @@ This project will help you learn about :
### Instructions
- Your project must be written in **Go**.
- The code must respect the **good practices**.
- The code must respect the [**good practices**](https://github.com/01-edu/public/good-practices.en.md).
- It is recommended that the code should present a **test file**.
- You should build your one files with the templates you desire.

2
subjects/ascii-output.en.md

@ -19,7 +19,7 @@ This project will help you learn about :
### Instructions
- Your project must be written in **Go**.
- The code must respect the **good practices**.
- The code must respect the [**good practices**](https://github.com/01-edu/public/good-practices.en.md).
- It is recommended that the code should present a **test file**.
- You may use the same `banner` file.

28
subjects/good-practices.en.md

@ -0,0 +1,28 @@
## good practices
### [code](https://code.tutsplus.com/tutorials/top-15-best-practices-for-writing-super-readable-code--net-8118)
- Commenting and Documentation
- Consistent Indentation
- Avoid Obvious Comments
- Code Grouping
- Consistent Naming Scheme
- camelCase
- under_scores
- [**DRY**](https://thefullstack.xyz/dry-yagni-kiss-tdd-soc-bdfu) (Don't Repeat Yourself) or [**DIE**](https://thefullstack.xyz/dry-yagni-kiss-tdd-soc-bdfu) (Duplication is Evil) principle
- [**KISS**](https://thefullstack.xyz/dry-yagni-kiss-tdd-soc-bdfu) (Keep It Simple Stupid)
- [**YAGNI**](https://thefullstack.xyz/dry-yagni-kiss-tdd-soc-bdfu) (You Aren’t Gonna Need It)
- [**SOC**](https://thefullstack.xyz/dry-yagni-kiss-tdd-soc-bdfu) (Separation of Concerns)
- Avoid Deep Nesting
- Limit Line Length
- File and Folder Organization
- Consistent Temporary Names
- Separation of Code and Data
- Code Refactoring
### Go
- [**Go**](https://golang.org/doc/effective_go.html)
- [**gofmt**](https://golang.org/cmd/gofmt/)
- [**goimports**](https://godoc.org/golang.org/x/tools/cmd/goimports)
- [**foimports vs gofmt**](https://goinbigdata.com/goimports-vs-gofmt/)
Loading…
Cancel
Save