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

Set up the CONTRIBUTING guide. #390

Open
Aloento opened this issue Aug 9, 2022 · 4 comments
Open

Set up the CONTRIBUTING guide. #390

Aloento opened this issue Aug 9, 2022 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Aloento
Copy link
Member

Aloento commented Aug 9, 2022

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

According to the discussion, we will move STYLEGUIDE to CONTRIBUTING and update the new version of the rules.

@Aloento Aloento added the documentation Improvements or additions to documentation label Aug 9, 2022
@Aloento
Copy link
Member Author

Aloento commented Aug 9, 2022

As we will discard the Extract, I suggest that we change the file structure, requests / results / urls, from results to types.
Then move all struct to types.go and classified by the method in which they are used.

Or let's write it in a better way.
Each file contains only one method with the resources it uses, and the file name is the same as the method name.

@anton-sidelnikov @outcatcher

@outcatcher
Copy link
Contributor

@Aloento
Generally I'm against splitting files per method, but in this case it seems to be a better approach, both because files become smaller and because you don't have to move between files to get whole context.

@Aloento
Copy link
Member Author

Aloento commented Aug 9, 2022

@outcatcher yes, that's what I'm considering. We can get a better file structure, easier to find and organize.

@outcatcher
Copy link
Contributor

Please add that using fmt.Errorf("message: %w", err) for wrapping errors is strongly encouraged. This improves understanding of errors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants