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

Use a bulleted list for the ADOPTERS file #4994

Merged
merged 2 commits into from
Sep 17, 2024

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Sep 17, 2024

Description

The Markdown table will become hard to maintain over time, especially if there are multiple pull requests for new adopters. Using a bulleted list makes merge conflicts a little less likely, and a little easier to resolve.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@twz123 twz123 added the chore label Sep 17, 2024
@twz123 twz123 requested a review from a team as a code owner September 17, 2024 11:00
@twz123 twz123 requested review from kke and makhov September 17, 2024 11:00
ADOPTERS.md Outdated Show resolved Hide resolved
The Markdown table will become hard to maintain over time, especially
if there are multiple pull requests for new adopters. Using a bulleted
list makes merge conflicts a little less likely, and a little easier
to resolve.

Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>
Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>
Copy link
Member

@jnummelin jnummelin left a comment

Choose a reason for hiding this comment

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

LGTM, very good point on the maintainability challenges tables would create 👍

@twz123 twz123 merged commit 68714ba into k0sproject:main Sep 17, 2024
5 checks passed
@twz123 twz123 deleted the adopters-bullets branch September 17, 2024 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants