浏览代码

adding layout references

chore/proposed-structure
Kyle Quest 7 年前
父节点
当前提交
55ba244c26
共有 7 个文件被更改,包括 38 次插入0 次删除
  1. +12
    -0
      README.md
  2. +4
    -0
      api/README.md
  3. +4
    -0
      cmd/README.md
  4. +4
    -0
      docs/README.md
  5. +4
    -0
      examples/README.md
  6. +6
    -0
      test/README.md
  7. +4
    -0
      tools/README.md

+ 12
- 0
README.md 查看文件

@@ -20,6 +20,8 @@ Don't put a lot of code in the application directory. If you think the code can

It's common to have a small `main` function that imports and invokes the code from the `/internal` and `/pkg` directories and nothing else.

See the `/cmd` directory for examples.

### `/internal`

Private application and library code. This is the code you don't want others importing in their applications or libraries.
@@ -44,6 +46,8 @@ Don't commit your application dependencies if you are building a library.

OpenAPI/Swagger specs, JSON schema files, protocol definition files.

See the `/api` directory for examples.

## Web Application Directories

### `/web`
@@ -84,20 +88,28 @@ IaaS, PaaS, system and container orchestration deployment configurations and tem

Additional external test apps and test data.

See the `/test` directory for examples.

## Other Directories

### `/docs`

Design and user documents (in addition to your godoc generated documentation).

See the `/docs` directory for examples.

### `/tools`

Supporting tools for this project. Note that these tools can import code from the `/pkg` and `/internal` directories.

See the `/tools` directory for examples.

### `/examples`

Examples for your applications and/or public libraries.

See the `/examples` directory for examples.

### `/third_party`

External helper tools, forked code and other 3rd party utilities (e.g., Swagger UI).


+ 4
- 0
api/README.md 查看文件

@@ -1,3 +1,7 @@
# `/api`

OpenAPI/Swagger specs, JSON schema files, protocol definition files.

Examples:

* https://github.com/openshift/origin/tree/master/api

+ 4
- 0
cmd/README.md 查看文件

@@ -7,3 +7,7 @@ The directory name for each application should match the name of the executable
Don't put a lot of code in the application directory. If you think the code can be imported and used in other projects, then it should live in the `/pkg` directory. If the code is not reusable or if you don't want others to reuse it, put that code in the `/internal` directory. You'll be surprised what others will do, so be explicit about your intentions!

It's common to have a small `main` function that imports and invokes the code from the `/internal` and `/pkg` directories and nothing else.

Examples:

* https://github.com/heptio/ark/tree/master/cmd

+ 4
- 0
docs/README.md 查看文件

@@ -1,3 +1,7 @@
# `/docs`

Design and user documents (in addition to your godoc generated documentation).

Examples:

* https://github.com/openshift/origin/tree/master/docs

+ 4
- 0
examples/README.md 查看文件

@@ -1,3 +1,7 @@
# `/examples`

Examples for your applications and/or public libraries.

Examples:

* https://github.com/docker-slim/docker-slim/tree/master/examples

+ 6
- 0
test/README.md 查看文件

@@ -1,3 +1,9 @@
# `/test`

Additional external test apps and test data.

Examples:

* https://github.com/openshift/origin/tree/master/test (test data is in the `/testdata` subdirectory)



+ 4
- 0
tools/README.md 查看文件

@@ -1,3 +1,7 @@
# `/tools`

Supporting tools for this project. Note that these tools can import code from the `/pkg` and `/internal` directories.

Examples:

* https://github.com/openshift/origin/tree/master/tools

正在加载...
取消
保存