Maintainer's guide, et al. #726

sdboyer · 2017-06-06T02:18:22Z

What does this do / why do we need it?

This adds a maintainer's guide to CONTRIBUTING.md, and templates for issues and PRs.

cc @ibrasho @darkowlzz @carolynvs 😄

What should your reviewer look out for in this PR?

Typos, things that don't make sense, wordiness, etc. in the guide.

Which issue(s) does this PR fix?

Helps with #629, but doesn't quite fix it.

carolynvs · 2017-06-06T02:32:00Z

.github/ISSUE_TEMPLATE.md

+
+-->
+
+### What version of Go (`go version`) and `dep` are you using?


Since we don't have dep version, let's ask people to run git describe --tags.

Maybe it's time we gave #209 some love? 😁
git describe --tags has to be run within dep directory within GOPATH to report dep version and that isn't clear for many people and they might end up reporting their git repo tags (or worse report an error if their git repo doesn't have tags).

carolynvs · 2017-06-06T02:35:46Z

.github/PULL_REQUEST_TEMPLATE.md

+### What should your reviewer look out for in this PR?
+
+### Which issue(s) does this PR fix? 
+


### Are there any parts that you are need help/answers/clarification?

carolynvs · 2017-06-06T02:36:45Z

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+### What does this do / why do we need it?


### PR Title Put the word WIP in the title if you are submitting this PR and are continuing to work on it. That way we'll know it's not 100% finished.

carolynvs · 2017-06-06T02:38:01Z

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to Dep

-Dep is an open source project.
+`dep` is an open source project.


Do we want to change other instances of Dep to dep in this doc?, like on line 1?

yeah, worth doing

carolynvs · 2017-06-06T02:38:21Z

CONTRIBUTING.md

+
+### General guidelines
+
+* _Be kind, respectful, and inclusive_. Really live [that CoC](https://github.com/golang/dep/blob/master/CODE_OF_CONDUCT.md). We've developed a reputation as one of the most welcoming and supportive project environments in the Go community, and we want to keep that up!


carolynvs · 2017-06-06T02:42:46Z

CONTRIBUTING.md

+* We use [Zenhub](https://www.zenhub.com) to manage the queue, in addition to what we do with labels.
+  * Pipelines, and [the board](https://github.com/golang/dep#boards) are one thing we try to utilize
+  * Marking dependencies/blockers is also quite useful where appropriate; please do that.
+  * We use epics and milestones in roughly the same way (because OSS projects don't have real sprints). Epics should be duplicated as milestones; if there's a main epic issue, it should contain a checklist of the relevant issues to complete it.


Good to know! I'll make sure we have that for the init importers.

carolynvs · 2017-06-06T02:48:12Z

CONTRIBUTING.md

+
+### Issue management
+
+* We use [Zenhub](https://www.zenhub.com) to manage the queue, in addition to what we do with labels.


* Zenhub Pipelines * `New Issues`: When someone creates a new issue, it goes here first. Keep an eye out for issues that fall into your area. Add labels to them, and if it's something we should do, put it in the `Backlog` pipeline. If you aren't sure, throw it in the `Icebox`. It helps to sort this pipeline by date. * `Icebox`: Issues that we aren't immediately closing but aren't really ready to be prioritized and started on. It's not a wontfix bucket, but a "not sure if we should/can fix right now" bucket. * `Backlog`: Issues that we know we want to tackle. You can drag/drop up and down to prioritize issues. * Hopefully the rest are self explanatory.

Feel free to just push that change directly to this branch 😄

carolynvs · 2017-06-06T02:50:54Z

CONTRIBUTING.md

+
+* Try to encourage, and make, smaller pull requests.
+* [No is temporary. Yes is forever](https://blog.jessfraz.com/post/the-art-of-closing/).
+* Long-running feature branches should generally be avoided. Discuss it with other maintainers first.


I'm unclear on what constitutes a long running feature branch but I know I'm a repeat offender. 😊 I usually only realize after the fact and am not always sure when to cry uncle and how to fix it though.

Or are you referring to something else?

Ah sorry, no, I didn't mean long-running PRs (though those pose a similar problem). I meant an actual branch in the dep repo that we merge multiple PRs into, with the intent of merging it all into master later.

carolynvs · 2017-06-06T02:52:19Z

CONTRIBUTING.md

+* [No is temporary. Yes is forever](https://blog.jessfraz.com/post/the-art-of-closing/).
+* Long-running feature branches should generally be avoided. Discuss it with other maintainers first.
+* Unless it's trivial, don't merge your own PRs - ask another maintainer.
+* Commits should follow [Tim Pope's rules](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).


How do you feel about contributors submitting PRs with magic commands like "Fixes #X" in the commit message?

It doesn't bother me - we can always edit their OP and change it if it's inaccurate.

My preferences is to give contributors as much ownership and control as we reasonably can. In cases like this, where the effort required of maintainers to manage that gifted power is minimal, IMO it's entirely worth it.

carolynvs · 2017-06-06T02:55:08Z

CONTRIBUTING.md

+   * Does the first post in the PR contain "Fixes #..." text for any issues it resolves?
+   * Are any necessary follow-up issues _already_ posted, prior to merging?
+   * Does this change entail the updating of any docs?
+       * For docs kept in the repo, e.g. FAQ.md, docs changes _must_ be submitted as part of the same PR.


googlebot · 2017-06-06T04:11:23Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

ibrasho · 2017-06-06T08:42:41Z

.github/ISSUE_TEMPLATE.md

+
+Paste the output of the commands you ran in here, making sure to pass -v for maximum context.
+
+Including the ouptut of `dep hash-inputs` may also be helpful to include here.


s/ouptut/output/

ibrasho · 2017-06-06T09:03:02Z

CONTRIBUTING.md

+### Issue management
+
+* We use [Zenhub](https://www.zenhub.com) to manage the queue, in addition to what we do with labels.
+  * Pipelines, and [the board](https://github.com/golang/dep#boards) are one thing we try to utilize


Missing punctuation at line end.

darkowlzz · 2017-06-06T17:43:47Z

LGTM 👍

As we are discussing how we would be maintaining dep well with multiple maintainers, how about using some tools to help us in doing so.
I came across zappr. It offers a bunch of tools to help maintainers. Among them, I like Approval check, Pull request labels check and Pull request tasks check.

Maybe we can look into it in the future, but I feel such tools, especially approval check, would help us in avoiding manually looking for approval comments and sometimes, even making mistakes.

Thoughts?

sdboyer · 2017-06-06T18:27:38Z

If zappr does what it claims, then I'm definitely 👍 . Commit message rules and approval enforcement would both be beneficial.

sdboyer added 2 commits June 5, 2017 21:47

Add first draft of maintainer's guide

c55af05

Add issue and PR templates

0fd5e0a

googlebot added the cla: yes label Jun 6, 2017

carolynvs reviewed Jun 6, 2017

View reviewed changes

Explain our zenhub pipelines

bac56b4

googlebot added cla: no and removed cla: yes labels Jun 6, 2017

sdboyer added cla: human-approved and removed cla: no labels Jun 6, 2017

ibrasho reviewed Jun 6, 2017

View reviewed changes

Update with review comments

587698a

googlebot added the cla: no label Jun 6, 2017

Clarify aligning with toolchain a bit more

e4246bd

carolynvs approved these changes Jun 6, 2017

View reviewed changes

ibrasho approved these changes Jun 7, 2017

View reviewed changes

sdboyer merged commit 9e747df into golang:master Jun 7, 2017

sdboyer changed the title ~~Maintainer's guide, et. all~~ Maintainer's guide, et al. Jul 26, 2017

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Maintainer's guide, et al. #726

Maintainer's guide, et al. #726

sdboyer commented Jun 6, 2017

carolynvs Jun 6, 2017

ibrasho Jun 6, 2017

carolynvs Jun 6, 2017

carolynvs Jun 6, 2017

carolynvs Jun 6, 2017

sdboyer Jun 6, 2017

carolynvs Jun 6, 2017

carolynvs Jun 6, 2017

carolynvs Jun 6, 2017 •

edited

Loading

sdboyer Jun 6, 2017

carolynvs Jun 6, 2017

carolynvs Jun 6, 2017

sdboyer Jun 6, 2017

carolynvs Jun 6, 2017

sdboyer Jun 6, 2017

sdboyer Jun 6, 2017

carolynvs Jun 6, 2017

googlebot commented Jun 6, 2017

ibrasho Jun 6, 2017

ibrasho Jun 6, 2017

darkowlzz commented Jun 6, 2017

sdboyer commented Jun 6, 2017


		-->

		### What version of Go (`go version`) and `dep` are you using?

		### What should your reviewer look out for in this PR?

		### Which issue(s) does this PR fix?


		### General guidelines

		* _Be kind, respectful, and inclusive_. Really live [that CoC](https://github.com/golang/dep/blob/master/CODE_OF_CONDUCT.md). We've developed a reputation as one of the most welcoming and supportive project environments in the Go community, and we want to keep that up!


		### Issue management

		* We use [Zenhub](https://www.zenhub.com) to manage the queue, in addition to what we do with labels.


		Paste the output of the commands you ran in here, making sure to pass -v for maximum context.

		Including the ouptut of `dep hash-inputs` may also be helpful to include here.

Maintainer's guide, et al. #726

Maintainer's guide, et al. #726

Conversation

sdboyer commented Jun 6, 2017

What does this do / why do we need it?

What should your reviewer look out for in this PR?

Which issue(s) does this PR fix?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carolynvs Jun 6, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

googlebot commented Jun 6, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

darkowlzz commented Jun 6, 2017

sdboyer commented Jun 6, 2017

carolynvs Jun 6, 2017 •

edited

Loading