Skip to content

Add open-source boilerplate#96

Merged
benjaminjkraft merged 3 commits intomainfrom
benkraft.oss
Sep 16, 2021
Merged

Add open-source boilerplate#96
benjaminjkraft merged 3 commits intomainfrom
benkraft.oss

Conversation

@benjaminjkraft
Copy link
Collaborator

Summary:

There's a lot these days! I got most of it from the GitHub docs [1], as
well as looking at other projects. I'll probably hold off on landing
this until a couple more things land, then land this and tag v0.1.0.

[1] https://docs.github.com/en/communities

Issue: #35

Test plan: view in github UI

There's a lot these days! I got most of it from the GitHub docs [1], as well as looking at other projects. I'll probably hold off on landing this until a couple more things land, then land this and tag v0.1.0. [1] https://docs.github.com/en/communities Issue: #35 Test plan: view in github UI Reviewers: steve, jvoll, marksandstrom, mahtab, miguel, adam
@benjaminjkraft benjaminjkraft self-assigned this Sep 15, 2021
@benjaminjkraft benjaminjkraft linked an issue Sep 15, 2021 that may be closed by this pull request
8 tasks
@benjaminjkraft benjaminjkraft mentioned this pull request Sep 15, 2021
8 tasks
@benjaminjkraft
Copy link
Collaborator Author

@dangoor
Copy link

dangoor commented Sep 15, 2021

Nice! Yeah, there are a lot of little bits and pieces, but it does make for a cleaner launch. Thanks!

Copy link
Member

@jvoll jvoll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've never open-sourced anything before but, this seems good to me!

Copy link
Member

@StevenACoffman StevenACoffman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One other possible badge. It looks like it's impossible for the test badge to ever change though?

README.md Outdated
[![Go Reference](https://pkg.go.dev/badge/github.com/Khan/genqlient.svg)](https://pkg.go.dev/github.com/Khan/genqlient)
[![Test Status](https://github.com/Khan/genqlient/actions/workflows/go/badge.svg)](https://github.com/Khan/genqlient/actions)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](docs/CODE_OF_CONDUCT.md)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[![GoReportcard](https://goreportcard.com/badge/github.com/Khan/genqlient?status.svg)](https://goreportcard.com/report/github.com/Khan/genqlient)
@StevenACoffman
Copy link
Member

StevenACoffman commented Sep 16, 2021

The https://goreportcard.com/report/github.com/Khan/genqlient reports some linting nits which it might be worth addressing to give people more confidence.

line 34 - warning: "impelmentation" is a misspelling of "implementations" (misspell)

@benjaminjkraft
Copy link
Collaborator Author

benjaminjkraft commented Sep 16, 2021

It looks like it's impossible for the test badge to ever change though?

What do you mean? I think it would change if, say, someone merged a PR overriding the failing checks. Or am I missing something that would cause it to stay green even in that case? (Of course we don't intend to do that, and honestly I think all the badges* are kinda unnecessary, but I can see how it provides some value for people to know that we are actually careful about the things we should be careful about.)

*other than the pkg.go.dev one, which is a useful icon for a necessary link

The https://goreportcard.com/report/github.com/Khan/genqlient reports some linting nits which it might be worth addressing to give people more confidence.

I fixed the typo (#100). The rest of the suggestions appear to be:

  • unnecessary suggestions from a deprecated tool, mostly about missing documentation in an internal (and test-only) package
  • incorrect suggestions supposedly from ineffassign, but they must be from a broken version because we run that linter in golangci-lint

That doesn't make me think there is significant value to genqlient in suggestions Go Report Card. I can add the badge, though, since I guess an "A" is a "good" grade even if I fully intend to ignore their suggestions going forward.

(begrudgingly, but anyway)
@StevenACoffman
Copy link
Member

Ah great. Thanks!

@benjaminjkraft benjaminjkraft merged commit 1d6e728 into main Sep 16, 2021
@benjaminjkraft benjaminjkraft deleted the benkraft.oss branch September 16, 2021 19:05
benjaminjkraft added a commit that referenced this pull request Sep 16, 2021
I'm not going to really publicize it until the blog post is done, but with all the usual boilerplate set up, it's time to remove this note! (Actually, I meant to do it in #96, but forgot.) Test plan: read it Reviewers: steve, marksandstrom, kevindangoor
benjaminjkraft added a commit that referenced this pull request Sep 16, 2021
## Summary: I'm not going to really publicize it until the blog post is done, but with all the usual boilerplate set up, it's time to remove this note! (Actually, I meant to do it in #96, but forgot.) ## Test plan: read it Author: benjaminjkraft Reviewers: dnerdy, dangoor, StevenACoffman Required Reviewers: Approved By: dnerdy, dangoor Checks: ✅ Test (1.17), ✅ Test (1.16), ✅ Test (1.15), ✅ Test (1.14), ✅ Lint, ✅ Test (1.17), ✅ Test (1.16), ✅ Test (1.15), ✅ Test (1.14), ✅ Lint Pull Request URL: #102
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

4 participants