add core API style guide #49
Labels
enhancement
New feature or request
hacktoberfest
Tasks for hacktoberfest :D
help wanted
Extra attention is needed
question
Further information is requested
@Mzack9999 and I had a really great conversation about creating a "style guide" for the core API.
Example
If I am making a new source, should I create a
newSource()
function that returns a*Source
or do you just call&Source{}
? Currently, I've been enforcing the more direct call to&Source{}
which reduces the needed boilerplate to write a new source and directly uses Go's own initialization patterns instead of having a more traditional object orientated pattern with an explicit initializer function.Examples and explanations can/should be curated to cultivate a unified style other developers can use.
The text was updated successfully, but these errors were encountered: