From 39eee51ec8f0bcd45e10d1209952d8f92e9e0936 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lucas=20K=C3=A4ldstr=C3=B6m?= Date: Tue, 14 Jul 2020 15:01:51 +0300 Subject: [PATCH] Add extra goals of best practices --- docs/proposals/go-git-providers.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/proposals/go-git-providers.md b/docs/proposals/go-git-providers.md index 197c7d65..3f2db98f 100644 --- a/docs/proposals/go-git-providers.md +++ b/docs/proposals/go-git-providers.md @@ -24,6 +24,7 @@ client for multiple providers and domains. - Support sub-organizations (or "sub-groups" in GitLab) if possible - Pagination is automatically handled for `LIST` requests - 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 @@ -46,6 +47,7 @@ client for multiple providers and domains. - 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 - 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