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

Re-write Contributing docs #3022

Merged
merged 5 commits into from
Jan 11, 2021

Conversation

Callisto13
Copy link
Contributor

@Callisto13 Callisto13 commented Jan 4, 2021

There is quite a lot here. I suggest you don't read the raw markdown, but the nicely rendered stuff instead (I have linked them).

This is part of the general community strategy, which I will share later.

It would be great if we could get this PR signed off by EOD 08.01.20, ty!

Description

Please let me know if there is anything you would like to remove or if there is anything I have missed which we should add. This PR is a big part of the community strategy which I will share soon.

Checklist

  • Added tests that cover your change (if possible)
  • Added/modified documentation as required (such as the README.md, or the userdocs directory)
  • Manually tested
  • Added labels for change area (e.g. area/nodegroup), target version (e.g. version/0.12.0) and kind (e.g. kind/improvement)
  • Make sure the title of the PR is a good description that can go into the release notes

What was I listening to when I wrote this? A lot of Long Distance Calling.

@Callisto13 Callisto13 added kind/docs User documentation skip-release-notes Causes PR not to show in release notes labels Jan 4, 2021
@Callisto13 Callisto13 requested a review from a team January 5, 2021 09:19
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
MAINTAINER.md Outdated Show resolved Hide resolved
COMMUNITY.md Outdated Show resolved Hide resolved
MAINTAINER.md Outdated Show resolved Hide resolved
@Callisto13 Callisto13 force-pushed the cb-contrib-docs-changes branch from 1e8a030 to e484ce7 Compare January 5, 2021 12:02
@Callisto13 Callisto13 force-pushed the cb-contrib-docs-changes branch 3 times, most recently from 6584c98 to 6a89e5b Compare January 7, 2021 12:04
@Callisto13 Callisto13 requested a review from a team January 7, 2021 12:07
Copy link
Contributor

@aclevername aclevername left a comment

Choose a reason for hiding this comment

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

LGTM! 1 minor nitpick 😄


*Note:* This is still somewhat [TBD](https://github.com/weaveworks/eksctl/issues/215).
# Proposals
Copy link
Contributor

Choose a reason for hiding this comment

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

can we get a markdown template for proposals?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure 👍 . I can submit that in a separate PR to give people more space to consider the format

Copy link
Contributor

Choose a reason for hiding this comment

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

sounds good 👍

Copy link

@mnowster mnowster left a comment

Choose a reason for hiding this comment

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

Overall I think this is a good refresh and I like the upbeat and welcoming tone. Thank you for taking the time to go through this and expand on detail in relevant places which helps us and them.

I've left minor comments, no blockers from me 👍🏻

.github/ISSUE_TEMPLATE/request-for-help.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
COMMUNITY.md Outdated Show resolved Hide resolved
COMMUNITY.md Outdated Show resolved Hide resolved
COMMUNITY.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
Copy link
Contributor

@michaelbeaumont michaelbeaumont left a comment

Choose a reason for hiding this comment

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

LGTM

@Callisto13 Callisto13 force-pushed the cb-contrib-docs-changes branch from 6a89e5b to 0b044f1 Compare January 11, 2021 15:31
@Callisto13 Callisto13 merged commit 874674b into eksctl-io:master Jan 11, 2021
@Callisto13 Callisto13 deleted the cb-contrib-docs-changes branch January 11, 2021 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs User documentation skip-release-notes Causes PR not to show in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants