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

An Examples Folder #442

Open
KaviiSuri opened this issue Oct 30, 2022 · 1 comment
Open

An Examples Folder #442

KaviiSuri opened this issue Oct 30, 2022 · 1 comment

Comments

@KaviiSuri
Copy link
Contributor

Is your feature request related to a problem? Please describe.
As someone exploring a library or a contributor, it can be messy to create a sandbox project to test out the local version.

I'm not sure if this is worth maintaining, but I just wanted to propose the idea.

Describe the solution you'd like
An example folder, similar to how it's done in the webpush-go package can solve this easily.

The example folder may contain examples for each type service, with the required setup code.

@AboutSange
Copy link

Yes, I agree, An example folder is very useful.
The example folder structure could be like this:

service/
    mail/
        example/
            example.go
        mail.go
        mail_test.go
        README.go

And example.go could be like this:

package main

func main() {
...
}

And then we can run go run example.go directly for real test.

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

No branches or pull requests

2 participants