docs: add Scope community baseline documentation by 2opremio · Pull Request #3192 · weaveworks/scope

2opremio · 2018-05-28T12:42:50Z

Stolen and adapted from the CNI project https://github.com/containernetworking/cni

MAINTAINERS

@@ -0,0 +1 @@
+Alfonso Acosta <fons@styntacticsugar.consulting> (@2opremio)


CONTRIBUTING.md

+By contributing to this project you agree to the Developer Certificate of
+Origin (DCO). This document was created by the Linux Kernel community and is a
+simple statement that you, as a contributor, have the legal right to make the
+contribution. See the [DCO](DCO) file for details.


CONTRIBUTING.md

+- Chat: Join the [Weave community](https://weaveworks.github.io/community-slack/) Slack workspace and use the [#scope](https://weave-community.slack.com/messages/scope/) channel
+
+Please avoid emailing maintainers found in the MAINTAINERS file directly. They
+are very busy and read the mailing lists.


CONTRIBUTING.md

+
+- Fork the repository on GitHub
+- Read the [README](README.md) for getting started as a user and learn how/where to ask for help 
+- Continue reading this document for forther development instructions


CONTRIBUTING.md

+- Make sure your commit messages are in the proper format (see below).
+- Push your changes to a topic branch in your fork of the repository.
+- If you changed code:
+   - add automated tests to cover your changes


CONTRIBUTING.md

+make tests
+```
+
+There are integration tests for, but unfortunately it's hard to set them up in fork respositories and that setup is not documented. Help is needed to run integration tests in forks: https://github.com/weaveworks/scope/issues/2192


CONTRIBUTING.md

+## 3rd party plugins
+So you've built a Scope plugin. Where should it live?
+
+Until it matures, it should live in your own repo.


GOVERNANCE.md

+
+Scope's community goals and principles:
+
+1. Transition from a primarily Weaveworks project to a true community-driven project with autonomous governance.


GOVERNANCE.md

+
+## Github Project Administration
+
+Maintainers will be added to the containernetworking GitHub organization and added to the GitHub cni-maintainers team, and made a GitHub maintainer of that team.


dholbach · 2018-05-28T13:12:56Z

In general: great work! I left a couple of comments: some of it is just typos or stuff which can be easily clarified. A few other bits probably deserve some discussion.

GOVERNANCE.md

+1. Transition from a primarily Weaveworks project to a true community-driven project with autonomous governance.
+2. Fill-in the needs of the community with a chop-wood-and-carry-water attitude: expect to give back before you take if you want to make an impact. Demands and suggestions from community members will be taken into account but actions and help will be more-highly appreciated.
+
+[Alfonso Acosta](https://github.com/2opremio) will be in charge of ramping up the community: establishing governance, initial maintenance and chairing. Once the community reaches critical mass and sufficient maintainers are designed, the community will be self-managed.


dholbach · 2018-05-28T14:14:19Z

In general this looks good to go as a r1.

The following bits still might need figuring out though at some point.

Any DCO signing steps necessary? Either way, document.
Figure out who is member of the set of maintainers who are "grandfathered in".
Consider pointing to examples of good tests, the list of currently endorsed plugins and other places of interest.
Figure out acceptance criteria for plugins.
Update mission statement of the scope community.

dholbach · 2018-05-28T15:14:54Z

As I haven't been too closely involved with the Scope community yet, I'm a bit hesitant giving a +1 on a document which defines voting processes, etc. I'd be happier if the process portions of the docs wer indicated as a draft and discussed and approved in a meeting soon.

In general this is great work and I'm happy with it to get more of a governance around scope started.

I went ahead and filed issues for the other action items out of this PR and used the governance label.

2opremio · 2018-05-28T15:36:36Z

As I haven't been too closely involved with the Scope community yet, I'm a bit hesitant giving a +1 on a document which defines voting processes, etc.

There hasn't been a true community, which is what we are trying to change (PRs and changes were merged based exclusively on product and company interests). My idea is to provide a baseline we can evolve from, I don't think we need to be careful about existing actors because (with some exceptions) basically there were none. I will of course share this in the first meeting and ask for feedback though (it's in the agenda).

I'd be happier if the process portions of the docs wer indicated as a draft and discussed and approved in a meeting soon.

The governance document is explicitly tagged as Work in Progress in its first paragraph.

I went ahead and filed issues for the other action items out of this PR and used the governance label.

Thanks! I think we should merge this and use those tickets to fill in the gaps. Feel free to create another ticket to review the voting scheme if you think that's necessary.

dholbach · 2018-05-28T15:37:50Z

Cool. WFM. I'll file the ticket. Just to make sure people can have their say.

* Rename code of conduct for consistency * Add maintainers file * Steal governance and contributing documents from CNI * docs: adapt goverance documents to Scope

2opremio added 4 commits May 28, 2018 13:35

Rename code of conduct for consistency

1391fba

Add maintainers file

db3394c

Steal governance and contributing documents from CNI

a2b94c4

docs: adapt goverance documents to Scope

9473e04

2opremio changed the title ~~docs: add Scope community baseline governance and contribution docs~~ docs: add Scope community baseline documentation May 28, 2018

2opremio requested a review from dholbach May 28, 2018 12:51

dholbach suggested changes May 28, 2018

View reviewed changes

dholbach reviewed May 28, 2018

View reviewed changes

2opremio added 2 commits May 28, 2018 16:02

Review feedback

6daa5ea

Add clarifications about plugins and mention meetings

7bc19c7

2opremio added 4 commits May 28, 2018 16:15

Improve phrasing

93d6897

Clarify goals

7e3e420

Simplify phrasing

a5cc962

Fix typo

d765a3c

2opremio mentioned this pull request May 28, 2018

update community resources weaveworks-plugins/scope-plugin-generator#4

Merged

dholbach added the governance Issue related to the governance of the Scope open source community label May 28, 2018

This was referenced May 28, 2018

Clarify DCO agreement steps #3193

Closed

Consider pointing to examples of good tests, the list of currently endorsed plugins and other places of interest #3194

Open

Figure out acceptance criteria for plugins #3196

Open

Fix typo

9d04cd4

This was referenced May 28, 2018

Update mission statement of Scope community #3197

Open

Figure out list of current maintainers #3198

Closed

dholbach approved these changes May 28, 2018

View reviewed changes

2opremio merged commit 282877e into master May 28, 2018

2opremio deleted the governance-contributing-docs branch May 28, 2018 15:39

dholbach mentioned this pull request May 28, 2018

Reviewing voting process #3199

Open

2opremio mentioned this pull request May 31, 2018

Missing MAINTAINERS file #2455

Closed

		@@ -0,0 +1 @@
		Alfonso Acosta <fons@styntacticsugar.consulting> (@2opremio)


		Scope's community goals and principles:

		1. Transition from a primarily Weaveworks project to a true community-driven project with autonomous governance.


		## Github Project Administration

		Maintainers will be added to the containernetworking GitHub organization and added to the GitHub cni-maintainers team, and made a GitHub maintainer of that team.

Comments

Conversation

2opremio commented May 28, 2018

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

dholbach commented May 28, 2018

Uh oh!

This comment was marked as abuse.

Uh oh!

This comment was marked as abuse.

Uh oh!

dholbach commented May 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dholbach commented May 28, 2018

Uh oh!

2opremio commented May 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dholbach commented May 28, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dholbach commented May 28, 2018 •

edited

Loading

2opremio commented May 28, 2018 •

edited

Loading