search

cncf / landscapeapp

🌄Upstream landscape generation application
https://landscapes.dev/
Apache License 2.0
255 stars 125 forks source link

README instructions and photo are slightly contradictory #883

Open Julian opened 1 year ago

Julian commented 1 year ago

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

The setup instructions say:

Set the repo to only support merge commits

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

image

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.

AndreyKozlov1984 commented 1 year ago

Hi, Julian! The landscape started its development 6 years ago, and no one could guess where it will lead to! Please use your favourite approach, "allow squash merging", it is a best one so far!

Feel free to make a PR for a change to the README and, please, metion me, @AndreyKozlov1984 , when you create it, I'll be happy to merge!

Julian commented 1 year ago

The landscape started its development 6 years ago, and no one could guess where it will lead to!

Amazing, thanks for the quick response and congrats on the success!

PR sent in #884!