Mirrors/flux2
1
0
Fork 0
mirror of synced 2026-02-14 05:26:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add extra goals of best practices

Browse Source
This commit is contained in:
Lucas Käldström
2020-07-14 15:01:51 +03:00
parent 7bb3a10795
commit 39eee51ec8
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/proposals/go-git-providers.md
View File

@@ -24,6 +24,7 @@ client for multiple providers and domains.
- Support sub-organizations (or "sub-groups" in GitLab) if possible - Support sub-organizations (or "sub-groups" in GitLab) if possible
- Pagination is automatically handled for `LIST` requests - Pagination is automatically handled for `LIST` requests
- Transparently can manage teams (collections of users, sub-groups in Gitlab) with varying access to repos - Transparently can manage teams (collections of users, sub-groups in Gitlab) with varying access to repos
- Follow library best practices in order to be easy to vendor (e.g. use major `vX` versioning & go.mod)
## Non-goals ## Non-goals
@@ -46,6 +47,7 @@ client for multiple providers and domains.
- Typed errors shall be returned, wrapped using Go 1.14's new features - Typed errors shall be returned, wrapped using Go 1.14's new features
- Go-style enums are used when there are only a few supported values for a field - Go-style enums are used when there are only a few supported values for a field
- Every field is documented using Godoc comment, including `+required` or `+optional` to clearly signify its importance - Every field is documented using Godoc comment, including `+required` or `+optional` to clearly signify its importance
- Support serializing the types to JSON (if needed for e.g. debugging) by adding tags
## Implementation ## Implementation