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

Docs: Add working groups to maintainer guide #11400

Merged
merged 3 commits into from Mar 15, 2019
Merged

Docs: Add working groups to maintainer guide #11400

merged 3 commits into from Mar 15, 2019

Conversation

nzakas
Copy link
Member

@nzakas nzakas commented Feb 15, 2019

What is the purpose of this pull request? (put an "X" next to item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Per the TSC meeting, this fleshes out how I envision working groups work. As best I can tell, this is how we've been doing things already and I'm just trying to document it. The only real change would be specifically listing out the working groups.

Is there anything you'd like reviewers to focus on?

Does this make sense?

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Feb 15, 2019
Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

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

Minor issues, but the proposal seems reasonable to be.

docs/maintainer-guide/README.md Outdated Show resolved Hide resolved
docs/maintainer-guide/working-groups.md Outdated Show resolved Hide resolved
@btmills btmills changed the title Docs; Add working groups to maintainer guide Docs: Add working groups to maintainer guide Feb 15, 2019
@not-an-aardvark not-an-aardvark added infrastructure Relates to the tools used in the ESLint development process evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Feb 18, 2019

## Creating a Working Group

Working groups are created by a standard TSC motion. Each working group:
Copy link
Member

Choose a reason for hiding this comment

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

In practice, is there a significant difference between:

  • an official working group
  • a group of team members collaborating on something without an official working group

...aside from the former having more clarity of structure?

I'm not sure I understand the advantage of requiring a TSC motion to create a working group and imposing limits on the size of working groups, in comparison with just letting team members create ad-hoc working groups through GitHub teams.

It seems like if some people want to collaborate but don't meet the requirements here, they would probably just decide to collaborate anyway without creating an official working group, which wouldn't be ideal from a documentation perspective.

Copy link
Member Author

Choose a reason for hiding this comment

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

As I mentioned in the meeting, the goal here is to make things explicit that up until this point have been implicit. For instance, if Kai and I had just disappeared and put together a website redesign on our own, then dropped it into an issue somewhere, that would be a bit jarring for the team. Maybe someone else was also working on a site redesign, or maybe someone else wanted to be involved.

Requiring a TSC motion means that there is a record of when a working group was formed and what for what purpose, so it's always easy to go back and figure out where it came from. It's also an opportunity for the team to weigh in and suggest who else might be good for the working group.

As I think we have a bunch of functional areas that some people are interested in, but not others (ops, finance, security, etc.), it seems like knowing who is actively working on these areas would be beneficial to the whole team.

Copy link
Member

Choose a reason for hiding this comment

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

Sorry, but I'm still not seeing the point of making this official policy. Whenever people want to start doing something, it my opinion, it's perfectly fine to announce it on gitter (or mailing list) and see if anyone else wants to participate. I'm not a fan of having policies for the sake of having policies.

Copy link
Member

Choose a reason for hiding this comment

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

I agree with @ilyavolodin. At the moment, our working groups are ad-hoc and undocumented. If the goal is to make things explicit that were previously implicit, then it seems like the natural step should be to make working groups ad-hoc and documented, and I think that change would be worthwhile (we could document the groups through something like GitHub teams). Requiring TSC approval for working groups seems like it would have the unrelated effect of making working groups not ad-hoc. It's not clear to me that such an approval process would be valuable over gitter/mailing list announcements, and it doesn't seem like it relates to the stated goal of making our existing process more explicit.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm fine with going the ad-hoc and documented route as a compromise. Would you both be open to the requirement that someone starting a working group should send an email to the team mailing list and create a GitHub team?

Copy link
Member

Choose a reason for hiding this comment

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

Sure, that works for me.

Copy link
Member

Choose a reason for hiding this comment

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

I guess I'm fine with that, I'm still not sure I see the point of having a GitHub team for, let's say server management, or website design. But I guess it's not a very large overhead to create one.

@nzakas
Copy link
Member Author

nzakas commented Mar 13, 2019 via email

@nzakas nzakas added the tsc agenda This issue will be discussed by ESLint's TSC at the next meeting label Mar 13, 2019
@nzakas
Copy link
Member Author

nzakas commented Mar 13, 2019

TSC Summary: This is the proposal for the formation of working groups, a loose way to organize and keep track of who is working on what on the project. WGs can be created by sending an email to the team mailing list to ask for interested team members, and then creating a GitHub team to signal who those members are.

TSC Action: Shall we accept this proposal?

@not-an-aardvark
Copy link
Member

This proposal was accepted in yesterday's TSC meeting.

@not-an-aardvark not-an-aardvark added accepted There is consensus among the team that this change meets the criteria for inclusion and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion tsc agenda This issue will be discussed by ESLint's TSC at the next meeting labels Mar 15, 2019
Copy link
Member

@not-an-aardvark not-an-aardvark left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@btmills btmills dismissed platinumazure’s stale review March 15, 2019 17:10

All of the comments have been addressed.

@btmills btmills merged commit d6c1122 into master Mar 15, 2019
@not-an-aardvark not-an-aardvark deleted the workinggroups branch March 15, 2019 17:17
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Sep 12, 2019
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Sep 12, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion infrastructure Relates to the tools used in the ESLint development process
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants