cncf / cncf/landscapeapp

README instructions and photo are slightly contradictory

Open
#883 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
253
Forks
116
PR merge metrics
No merged PRs in 30d

Description

(Hi! Thanks, nice looking tool. Just a very minor incongruity I figured I'd mention in case it's useful)

The [setup instructions](https://github.com/cncf/landscapeapp/tree/2bda551a74ea93ac93ee2be2640e06adf471cf55#creating-a-new-landscape) say:

> Set the repo to only support merge commits

But the screenshot shown just below show the opposite, checking only squash merges:

![image](https://github.com/cncf/landscapeapp/assets/329822/09b9e49c-bc0c-4872-b7fa-2131bd94a0ac)

I don't personally generally recommend doing that in a git repo, but if there's some reason why landscapes really do need to always merge using squash then probably the simple fix is to just tweak the text above to say "squash merge" rather than "merge". Happy to send a PR if so, but filing this first since I wasn't sure which is actually correct, the text or the image, or whether really this step isn't actually required.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.