Update README.md - Githubissues

azohra / shell-linter

A Github Action for ShellCheck

https://github.com/marketplace/actions/shell-linter

MIT License

66 stars 13 forks source link

Update README.md #45

Closed YueMiyuki closed 2 years ago

YueMiyuki commented 2 years ago

Fix error every step must define ausesorrunkey

Pull Request Checklist

[x] I have created an issue prior to creating this pull request
[x] I have provided a detailed description and motivation regarding the change below
[ ] I have updated the test suite and documentation to support my change

Corresponding Issue

#44

Description of Change

Changed the example and there will be no error

Motivation and Context

<ADD-MOTIVATION-HERE>

Testing Steps

<ADD-STEPS-HERE>

Risks

Additional Information

asadmansr commented 2 years ago

Thank you @ItzMiracleOwO for your interest in shell-linter. However, @tk8817 I'm not sure why this was merged into develop without the knowledge of the maintainers of this repo. A few of our users prefer using a specific branch to get the latest updates as opposed to a specific version. We cannot risk any breaking changes or errors being introduced. That also holds true for the README file or any wording that could cause confusion.

I'm proposing to revert this change in the coming few days. Let me know if you have any thoughts.

azohra commented 2 years ago

Hey Asad,

This looked like a safe update and I was worried the repo had actually gone stale due to how long this was open. Both of us have moved on to new companies along with many other Azohra members, but I consider us all co-owners and maintainers as time permits.

I am still active in our projects and keep close tabs on things! Been working with Avery & Gagan to get the websites back online for Strapped & Yaml.sh most recently.

I apologize for any disruption but not sure I follow how this posed a risk as it was carefully reviewed and merged, following the repo guidelines.

Azbagheri commented 2 years ago

Hey Justin,

I totally agree with @asadmansr on this. Other than the concerns that he has mentioned with this PR, I should add that we had fixed the original issue in another PR late December. As a result, this PR has only added a new line character to the README.

Thank you for keeping tabs on things! We are actively maintaining this repo and would appreciate it if we are kept in the loop with any changes to it. I apologize if open PRs have caused any confusion. Going forward, we’ll be more diligent about closing the duplicates.

We’re going to revert the change introduced in this PR. However, we definitely welcome future PRs that are more substantial.