simplesystems/go-resources
1
0
Fork 0
Code Issues 57 Pull Requests Activity

Update 'project_structure.md'

Browse Source
This commit is contained in:
jeff 2021-07-17 05:51:38 +00:00
parent 4603877ab0
commit d5538bbe3a
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
project_structure.md
View File

@ -23,20 +23,25 @@ The complexity scores are rough estimates, but are useful in realizing how compl
If your project is simple, do not add unnecessary structure. This increases the cognitive load of anyone trying to use the project. If your project is simple, do not add unnecessary structure. This increases the cognitive load of anyone trying to use the project.
### Organize Code by Responsibility ### Organize Code by Responsibility
When creating modules and packages, be sure to define what the package's responsibility is. This is encouraged by the standard go practice of having a [package comment](https://blog.golang.org/godoc). Difficulty in defining a responsibility/purpose is a sign of an unnecessary or too broad package.
### Package `internal` ### Package `internal`
`internal` is additional complexity, and should really only be used for packages with substantial users. If there are only a few people using the project and it is in development, it may not be necessary to use this.
[Use internal packages to reduce your public API surface](https://dave.cheney.net/2019/10/06/use-internal-packages-to-reduce-your-public-api-surface)
### Package `pkg` ### Package `pkg`
`pkg` should not be used in the package path. It is redudant at best (a package path always leads to a package).
[rakyll.org](https://rakyll.org/style-packages/)
[Organzing Go Code](https://talks.golang.org/2014/organizeio.slide#6)
[What's in a Name?](https://talks.golang.org/2014/names.slide#15)
### Use Encapsulation Tools to Create Project Structure ### Use Encapsulation Tools to Create Project Structure
Modules, packages, files, funcs, and structs are all encapsulation tools. Use them according to their purpose. Using a package for one exported func (and none unexported) is probably a misuse.
Just as structs, funcs, files, packages, and modules are ### Adding Complexity Should Have a Rationale
Adding packages adds complexity to your project. The onus is on the person adding the complexity to rationalize it. If there is no rationale, it should probably be removed.
### Adding Complexity Should be Justified
### Use Other Methods of Abstraction
### Other Resources
https://rakyll.org/style-packages/