awesome-jamstack icon indicating copy to clipboard operation
awesome-jamstack copied to clipboard

Published 20 hours ago • verified publisher icon automata

Comply with awesome-lint

Open jessevdp opened this issue 6 years ago • 9 comments

Currently the build is failing. I've tried to resolve some of the issues. Unfortunately, I wasn't able to resolve all of them. awesome-lint seems to be opinionated and expects certain elements (license, header) to exist in one format, while this repository uses a different format.

Resolving those issues should help streamline the contributing experience. Currently, all builds fail, so maintainers have to dig into the build logs every time to see if the added changes create more issues than already exist. If all existing issues are resolved, maintainers can simply trust the build status.

👀 Overview of Changes

  • To resolve the issue with the license, I've added the same exact license in txt format to the root of the repository.
  • There was a casing issue with one of the list items. I resolved it.
  • One of the list items was missing punctuation. I resolved it.

📋 Tasks

  • [ ] Fix awesome/heading issue. (after https://github.com/sindresorhus/awesome-lint/issues/90)
  • [ ] Fix false-positive errors regarding broken links. (after https://github.com/sindresorhus/awesome-lint/issues/89)
  • [x] Figure out what is going wrong with the license (https://github.com/sindresorhus/awesome-lint/issues/91)

jessevdp avatar Oct 03 '19 08:10 jessevdp

It seems that, even though I've added the LICENSE file, awesome-lint still doesn't recognize the license. Might this be because it is not yet at the base branch of the repository? (The error description mentions that "the license was not detected by GitHub.") However, a test/linter should look at the contents of a branch, not a repository . . . so that would be a bit weird.

jessevdp avatar Oct 03 '19 09:10 jessevdp

I've reported an issue regarding the awesome/heading rule. See https://github.com/sindresorhus/awesome-lint/issues/90.

jessevdp avatar Oct 04 '19 07:10 jessevdp

I've also opened an issue regarding the license. Even after adding it in a LICENSE file, it is still not detected. https://github.com/sindresorhus/awesome-lint/issues/91

jessevdp avatar Oct 04 '19 07:10 jessevdp

Great! Thank you! Let's keep this PR open to monitor third party issues, shall we?

automata avatar Oct 04 '19 19:10 automata

Yes. I’ve put it in draft mode, and I’m monitoring to-do items in the PR description.

jessevdp avatar Oct 05 '19 08:10 jessevdp

I figured out what is going on with the license linting error. (See https://github.com/sindresorhus/awesome-lint/issues/91#issuecomment-543116465.) It seems that the license is indeed checked on repo level, not for every branch. The license should be detected when this PR is merged into the default branch. The linting error should be gone for future PRs.

jessevdp avatar Oct 17 '19 10:10 jessevdp

@jessekelly881 still a WIP or should we get back to the review?

automata avatar Jun 17 '20 21:06 automata

It seems that two of the underlying 3rd party issues are still open. (Listed in the PR description.) In these cases the current setup does actually comply with the rules, just not with the automated checking of them. Unless someone puts in the work over there... we can't make the linter not report on them here.

What we can do is move these things that we have to wait for to separate issues and merge through the rest of the fixes. But the ultimate goal of this PR—to clean out all linter errors so that the build status was accurate again, allowing PR reviews to be simpler—can't be achieved yet.

If you decide to merge the current changes through, perhaps first update this branch and and go trough any additional linter errors that can be fixed now. Just to make sure the slate is clean.

jessevdp avatar Jun 18 '20 12:06 jessevdp

Hi! I am @jessekelly881! I'm guessing I'm not the Jesse that you are trying to tag in the conversation. Haha.

On Thu, Jun 18, 2020 at 7:31 AM Jesse van der Pluijm < [email protected]> wrote:

It seems that two of the underlying 3rd party issues are still open. (Listed in the PR description.) In these cases the current setup does actually comply with the rules, just not with the automated checking of them. Unless someone puts in the work over there... we can't make the linter not report on them here.

What we can do is move these things that we have to wait for to separate issues and merge through the rest of the fixes. But the ultimate goal of this PR—to clean out all linter errors so that the build status was accurate again, allowing PR reviews to be simpler—can't be achieved yet.

If you decide to merge the current changes through, perhaps first update this branch and and go trough any additional linter errors that can be fixed now. Just to make sure the slate is clean.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/automata/awesome-jamstack/pull/33#issuecomment-645987609, or unsubscribe https://github.com/notifications/unsubscribe-auth/AFPAKM53Q5VALNI7RG6LWRLRXICL3ANCNFSM4I5ABMJA .

jessekelly881 avatar Jun 29 '20 20:06 jessekelly881

Closing for now given the lack of updates, @jessevdp please feel free to re-open it.

automata avatar Aug 13 '22 05:08 automata