Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add core API style guide #49

Open
picatz opened this issue Jul 15, 2018 · 2 comments
Open

add core API style guide #49

picatz opened this issue Jul 15, 2018 · 2 comments
Assignees
Labels
enhancement New feature or request hacktoberfest Tasks for hacktoberfest :D help wanted Extra attention is needed question Further information is requested

Comments

@picatz
Copy link
Member

picatz commented Jul 15, 2018

@Mzack9999 and I had a really great conversation about creating a "style guide" for the core API.

Note: Nothing is finalized yet, but I think it would be really great to help new developers join working on the code base when they know what they are expected to do. Creating documentation can help ease in new developers by having resources they can rely on.

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.

@picatz picatz added enhancement New feature or request help wanted Extra attention is needed question Further information is requested labels Jul 15, 2018
@picatz
Copy link
Member Author

picatz commented Aug 7, 2018

Some work has been done on this in the README for sources: https://github.com/subfinder/research/blob/master/core/sources/README.md

@picatz
Copy link
Member Author

picatz commented Sep 24, 2018

This docs will need to be updated once #59 is merged into master.

@Ice3man543 Ice3man543 added hacktoberfest Tasks for hacktoberfest :D and removed hacktoberfest Tasks for hacktoberfest :D labels Sep 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest Tasks for hacktoberfest :D help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants