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

[README] Is folding correct under the «Install dependencies» section? #261

Closed
yermulnik opened this issue Oct 25, 2021 · 7 comments
Closed
Labels
feature New feature or request

Comments

@yermulnik
Copy link
Collaborator

yermulnik commented Oct 25, 2021

I've just noticed this strange folding thing in the README.md and am curious of whether this is intentional or I may go and PR the amendment?

I see this in 1. Install dependencies section of the README.md:
изображение

Here's the respective code snippet:

## How to install

### 1. Install dependencies

<!-- markdownlint-disable no-inline-html -->

* [`pre-commit`](https://pre-commit.com/#install),
  <sub><sup>[`terraform`](https://www.terraform.io/downloads.html),
  <sub><sup>[`git`](https://git-scm.com/downloads),
  <sub><sup>POSIX compatible shell,
  <sub><sup>Internet connection (on first run),
  <sub><sup>x86_64 compatible operation system,
  <sub><sup>Some hardware where this OS will run,
  <sub><sup>Electricity for hardware and internet connection,
  <sub><sup>Some basic physical laws,
  <sub><sup>Hope that it all will works.
  </sup></sub></sup></sub></sup></sub></sup></sub></sup></sub></sup></sub></sup></sub></sup></sub></sup></sub><br><br>

This makes sub/sup go deeper and hence making every next sub/sup item smaller and smaller.

@yermulnik yermulnik added the feature New feature or request label Oct 25, 2021
@MaxymVlasov
Copy link
Collaborator

Yes, it is intentional

Or do you think that things like Hope that it all will works. in the deps section should be readable? :D

@yermulnik
Copy link
Collaborator Author

yermulnik commented Oct 25, 2021

First of all this way of folding hides essential requirements like terraform, git, and shell.
Secondly a bit of good humor has never been something ugly 🤣 (of course if you didn't mean the typo before the trailing dot 😂)

@MaxymVlasov
Copy link
Collaborator

essential requirements like terraform, git, and shell.

Are you kidding me? :)

Who will go to use pre-commit-terraform hooks without terraform, git, and shell?
If they have not terraform, why are they here?
If they have not git - why do they try to look to git hooks?
If they have not shell - how did they find this repo at all?

@MaxymVlasov
Copy link
Collaborator

Also, I'm not sure about the POSIX-compatible shell. I just added that but did not check that hooks work with sh. As you can see in all hooks shebang, they used bash.

@yermulnik
Copy link
Collaborator Author

Are you kidding me? :)

hahaha, absolutely not at all =) That bit of code made be confused and hence we're here discussing it.

Who will go to use pre-commit-terraform hooks without terraform, git, and shell?

Well, jokes aside, the section is Install dependencies hence it'd better list all the deps so that users don't have to figure out them on their own or assume explicitly users are ready to go since they should have installed and used common toolset for at least some time now.

Also, I'm not sure about the POSIX-compatible shell.

If we agree to rely on Bash, I think we should list it as an explicit dependency to avoid any confusion.

Also despite me using bash'isms quite often, where there are no bash'isms used (bash-specific extension to the POSIX shell) Bash is full POSIX-compatible.
But yep, we either list Bash as a run dependency for pre-commit-terraform, or we make our best to avoid bash'isms and use only POSIX-compatible things in shell-scripts.

@yermulnik
Copy link
Collaborator Author

Eventually fixed via #267

@antonbabenko
Copy link
Owner

I also like Easter eggs but we are serious people, right? :trollface:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants