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

community: add mention of git bugreport #1464

Closed
phil-blain opened this issue May 20, 2020 · 9 comments · Fixed by #1479
Closed

community: add mention of git bugreport #1464

phil-blain opened this issue May 20, 2020 · 9 comments · Fixed by #1479

Comments

@phil-blain
Copy link
Contributor

Git 2.27 adds the git bugreport tool. Probably this should be mentioned on the "Community" page, and maybe featured in the "docs" page also.

@phil-blain phil-blain changed the title community: add mention of git bug-report community: add mention of git bugreport May 20, 2020
@peff
Copy link
Member

peff commented May 20, 2020

Agreed that it is probably worth mentioning (post-2.27 release, obviously). It might be worth discussing wording with @nasamuffin on the list (and possibly getting an overall review of the bug-reporting advice on that page).

@nasamuffin
Copy link
Contributor

I think it's a great idea. @phil-blain, were you wanting to work on it? Otherwise I can do a little blurb - I've got a couple more outstanding bugreport topics anyways, so I can still make time for it.

@peff
Copy link
Member

peff commented May 20, 2020

@nasamuffin Oh good, I wasn't sure if you'd get the ping since you weren't already in the org (or at least the @-mention didn't autocomplete you 😉). As somebody who's been thinking on this topic, I'd welcome any suggestions you have for improving the community page.

@phil-blain
Copy link
Contributor Author

phil-blain commented May 20, 2020

@nasamuffin you can go ahead.

While I have your attention, I noticed that MyFirstContribution, which I find is a really great resource, is not linked or mentioned from anywhere in the Git repo. I think it could be great to maybe mention it in Documentation/SubmittingPatches since it's linked to in the README, and probably also .github/CONTRIBUTING.md since that's what people are directed to on GitHub when they open a PR.

I added links to it in the website "Community" page and on Gitgitgadget's homepage but I think it deserves more exposure.

Same thing for "MyFirstObjectWalk" (could be linked to at then end of MyFirstContribution maybe ?

@nasamuffin
Copy link
Contributor

Sure. I'll see if I can spend a little time this week or next week to add pointers all over :) Thanks for noticing!

@nasamuffin
Copy link
Contributor

Should a patch for git/git-scm.com be reviewed on the list? Or should I just send a PR? I'm working on this today.

@peff
Copy link
Member

peff commented May 28, 2020

Should a patch for git/git-scm.com be reviewed on the list? Or should I just send a PR? I'm working on this today.

We've typically just used PRs for updates here. But then again, most of the changes aren't so community-oriented. The audience of Git devs here is way smaller than it would be on the list. So I'm happy to review a PR here, but it might be a good opportunity to get wider input by sending a patch to the list.

@nasamuffin
Copy link
Contributor

@nasamuffin
Copy link
Contributor

@nasamuffin you can go ahead.

While I have your attention, I noticed that MyFirstContribution, which I find is a really great resource, is not linked or mentioned from anywhere in the Git repo. I think it could be great to maybe mention it in Documentation/SubmittingPatches since it's linked to in the README, and probably also .github/CONTRIBUTING.md since that's what people are directed to on GitHub when they open a PR.

https://lore.kernel.org/git/20200528234939.145396-1-emilyshaffer@google.com

Same thing for "MyFirstObjectWalk" (could be linked to at then end of MyFirstContribution maybe ?

I think it's a fine idea; might also want to refer to it somewhere in other object walking docs. I'll save this task for another rainy day, but I won't be offended if you want to add it yourself :)

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

Successfully merging a pull request may close this issue.

3 participants