Skip to content

Adds Contrib Doc#27

Merged
danehans merged 4 commits into
mainfrom
issue_8
May 3, 2022
Merged

Adds Contrib Doc#27
danehans merged 4 commits into
mainfrom
issue_8

Conversation

@danehans
Copy link
Copy Markdown
Contributor

Adds a contrib doc based on Envoy and go-control-plane.

Fixes: #8

Signed-off-by: danehans daneyonhansen@gmail.com

Comment thread CONTRIBUTING.md Outdated
Comment on lines 78 to 79
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@LukeShu @youngnick note that this topic was discussed during a community meeting.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would use even stronger language and make it a requirement instead of a "general expectation". Perhaps we should also use the term "affiliation" rather than "organization" to distinguish it from GitHub orgs.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

See my response in #27 (comment)

youngnick
youngnick previously approved these changes Apr 29, 2022
@danehans
Copy link
Copy Markdown
Contributor Author

@LukeShu I would like all 3 organizations to review PRs during the early stages of the project, so PTAL and merge if all looks good to you.

@danehans danehans added the documentation Improvements or additions to documentation label Apr 29, 2022
@danehans danehans added this to the Public Announcement milestone Apr 29, 2022
@danehans danehans mentioned this pull request May 2, 2022
7 tasks
arkodg
arkodg previously approved these changes May 2, 2022
Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should provide links to GitHub and Slack as soon as the project and channels are made public.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, they will be added to the readme, xref.

Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

CHANGELOG.md doesn't exist yet.
xref: #54

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for creating the issue!

Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should change the repository's configuration to make "Squash and merge" the default.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done

Comment thread CONTRIBUTING.md Outdated
Comment on lines 78 to 79
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would use even stronger language and make it a requirement instead of a "general expectation". Perhaps we should also use the term "affiliation" rather than "organization" to distinguish it from GitHub orgs.

@danehans
Copy link
Copy Markdown
Contributor Author

danehans commented May 3, 2022

I would use even stronger language and make it a requirement instead of a "general expectation". Perhaps we should also use the term "affiliation" rather than "organization" to distinguish it from GitHub orgs.

I will update to use "affiliation" instead of "organization". I use "general expectation" due to the following caveat:

  • The above rules may be waived for PRs which only update docs or comments, or trivial changes to
    tests and tools (where trivial is decided by the maintainer in question).

I have updated this bullet to clearly state this is required, PTAL.

cc: @youngnick @skriss @arkodg @LukeShu

@danehans danehans dismissed stale reviews from arkodg and youngnick via 40777da May 3, 2022 15:54
@danehans danehans force-pushed the issue_8 branch 2 times, most recently from 40777da to 1163c07 Compare May 3, 2022 15:57
alexgervais
alexgervais previously approved these changes May 3, 2022
skriss
skriss previously approved these changes May 3, 2022
Copy link
Copy Markdown
Contributor

@skriss skriss left a comment

Choose a reason for hiding this comment

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

LGTM!

danehans added 3 commits May 3, 2022 11:36
Signed-off-by: danehans <daneyonhansen@gmail.com>
Signed-off-by: danehans <daneyonhansen@gmail.com>
Signed-off-by: danehans <daneyonhansen@gmail.com>
@danehans
Copy link
Copy Markdown
Contributor Author

danehans commented May 3, 2022

Had to rebase. PTAL and /approve if all looks good.

cc: @skriss @youngnick @alexgervais @alexgervais

Copy link
Copy Markdown
Contributor

@LukeShu LukeShu left a comment

Choose a reason for hiding this comment

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

I have no problems with this.

@danehans danehans merged commit 52504ff into main May 3, 2022
@danehans danehans deleted the issue_8 branch May 3, 2022 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create Contrib Guide

6 participants