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

chore(docs): update contributor wording and support channel info #11544

Merged
merged 1 commit into from
Sep 21, 2023

Conversation

hanshuebner
Copy link
Contributor

Summary

  • add community pledge
  • update support channel information and social links

Checklist

  • The Pull Request has tests
  • A changelog file has been added to CHANGELOG/unreleased/kong or adding skip-changelog label on PR if unnecessary. README.md
  • There is a user-facing docs PR against https://github.com/Kong/docs.konghq.com - PUT DOCS PR HERE

@hanshuebner hanshuebner requested a review from hbagdi September 11, 2023 12:32
@hanshuebner hanshuebner force-pushed the feat/community-comms-update branch 2 times, most recently from 7490fa1 to 0199049 Compare September 12, 2023 04:45
Copy link
Contributor

@nowNick nowNick left a comment

Choose a reason for hiding this comment

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

I like the honesty of this pledge! I left a tiny comment but more as an idea / inspiration. It looks good to me already 👏

CONTRIBUTING.md Outdated
Comment on lines 99 to 102
Recognizing that we operate as a commercial entity, we face the
challenge of balancing our commercial interests with the desire to
accommodate and support open source users and contributors
effectively.
Copy link
Contributor

Choose a reason for hiding this comment

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

I like the professional and honest wording of this paragraph however to me personally it stands out a little bit from the rest of this doc where we have phrasings like: "We welcome contributions of all kinds" or "tasks are noble and worthy".

I wonder if changing the order of sentences makes it more aligned with the doc sentiment. What do you think of this?:

We are thrilled to work with the community and we have a strong desire to accommodate and support open source users and contributors effectively. However since we also operate as commercial entity we face the bitter challenge of balancing community work with the interest of Kong Inc.

Copy link
Collaborator

Choose a reason for hiding this comment

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

re: "We make many of the enhancements to Kong Gateway in the
Community Edition, and thus they become available to the open source
community even before our commercial customers get them" <<-- this isn't strictly true is it? we often release a new EE version before the OSS version don't we? suggest we remove this (and it also conflicts with what we tell enterprise customers....). AFAIK we either release OSS/EE at the same time OR EE is slightly ahead of OSS

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nowNick I'm going to tone down the invitation to contribute a bit. It comes from six years ago, when Kong was primarily managed as Open Source project, and I agree that it does not quite align with what we're now pledging.

@teb510 Most enhancements become available in the open source repository first, but I understand your point and will change the wording.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@teb510 It now reads "We make many of the enhancements to Kong Gateway in the
Community Edition, so our open source community directly benefits from
the commercial work that we do."

Copy link
Contributor

@StarlightIbuki StarlightIbuki left a comment

Choose a reason for hiding this comment

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

The most important information for the contributor to notice would be the 7-day policy and ticket-closing policy. Should we outline and stress them?

CONTRIBUTING.md Outdated
Comment on lines 112 to 114
It also means that sometimes, we will be closing pull requests or
issue reports when we made the decision that we will not be able to
merge or resolve them in the foreseeable future. We do that in the
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we going to have a hard standard to consider a ticket stale? I'm OK with either having discretionary power or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have added this:

We automatically close issues and pull requests for which we do not get responses to our questions or update requests within 3 weeks.

CONTRIBUTING.md Outdated
@@ -13,6 +13,7 @@ Consult the Table of Contents below, and jump to the desired section.
- [Where to seek for help?](#where-to-seek-for-help)
- [Enterprise Edition](#enterprise-edition)
- [Community Edition](#community-edition)
- [Our pledge to the community](#our-pledge-to-the-community)
- [Where to report bugs?](#where-to-report-bugs)
- [Where to submit feature requests?](#where-to-submit-feature-requests)
- [Contributing](#contributing)
Copy link
Contributor

Choose a reason for hiding this comment

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

Just to add to this PR, I also want to include some suggestions for the contributors (maybe "best practices"?).
For example, smaller PRs are more likely to get reviewed soon. And maybe we could reveal some of our processes when reviewing the RP.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Feel free to contribute fixes or minor features by opening a Pull
Request. Small contributions are more likely to be merged quicker
than changes which require a lot of time to review. If you are
planning to develop a larger feature, please talk to us first in the
GitHub Discussions
section!

Does this suffice?

@hanshuebner hanshuebner force-pushed the feat/community-comms-update branch from 8a449e4 to b2d1ed9 Compare September 20, 2023 08:12
@pull-request-size pull-request-size bot added size/L and removed size/M labels Sep 20, 2023
@github-actions github-actions bot added the chore Not part of the core functionality of kong, but still needed label Sep 20, 2023
@hanshuebner
Copy link
Contributor Author

@StarlightIbuki I've put the Community Pledge into a separate document that is linked to from the pull request and issue template as well as from the contributor document. It contains some more details about our closing policy, too.

@hanshuebner hanshuebner marked this pull request as ready for review September 20, 2023 08:13
@github-actions github-actions bot added the author/community PRs from the open-source community (not Kong Inc) label Sep 20, 2023
@hanshuebner hanshuebner force-pushed the feat/community-comms-update branch from b2d1ed9 to b056216 Compare September 20, 2023 08:39
@hanshuebner hanshuebner merged commit 5d8061e into master Sep 21, 2023
21 checks passed
@hanshuebner hanshuebner deleted the feat/community-comms-update branch September 21, 2023 04:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author/community PRs from the open-source community (not Kong Inc) chore Not part of the core functionality of kong, but still needed core/docs size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants