zoidyzoidzoid / awesome-ebpf

A curated list of awesome projects related to eBPF.
Creative Commons Zero v1.0 Universal
4.31k stars 368 forks source link

Create LICENSE and fix most awesome-lint errors #23

Closed zoidyzoidzoid closed 5 years ago

zoidyzoidzoid commented 5 years ago

Except false positives about sub lists.

Makes some progress on https://github.com/zoidbergwill/awesome-ebpf/issues/22

GitHub doesn't include CC0 in its license templates, so I used the Unlicense which I think is similar.

Compared to before this PR, there are a lot less awesome-lint errors now. The only errors left are:

Before:

   1 remark-lint:awesome/badge
   1 remark-lint:awesome/github
 136 remark-lint:awesome/list-item
   2 remark-lint:awesome/spell-check
   1 remark-lint:awesome/toc
  51 remark-lint:list-item-bullet-indent
   1 remark-lint:no-dead-urls

After:

   1 remark-lint:awesome/github
   3 remark-lint:awesome/list-item
  51 remark-lint:list-item-bullet-indent
pchaigno commented 5 years ago

GitHub does recognize Creative Commons licenses: https://choosealicense.com/appendix/. If you use the text from choosealicense.com, it should be recognized automatically by Licensee.

zoidyzoidzoid commented 5 years ago

Thanks for the help with the license, @pchaigno. Replacing it with the text from there and sticking to CC0.

Thanks for your feedback, @qmonnet. Those are some great points, I was worried too with how to better deal with the hyphens between links and descriptions and how to better deal with the long lines.

  • You might want to choose a style for wrapping lines (pick a max line width and wrap, or never wrap at all) and stick to it for the whole document. Some line breaks look weird now.

So I think wrapping will make diffs cleaner for future edits and additions, but some of our links have long'ish titles which leads to trailing lines with a hyphen, which might be okay. I'll try stick to a sane max line length like 80 or 120 characters.

  • Some links miss a description, when the title is not super-explicit by itself.

Good point, I'll take a look through them all and try improve the titles or add a good description.

  • Some link titles or descriptions could maybe be slightly improved. But this is hard to see on the diff to be honest, it's probably better to address this (and previous item) as a follow-up once you have merged these changes.

Great point. It'll definitely be easier to address them in the future. I'll see what I can do in the mean time.

zoidyzoidzoid commented 5 years ago

Thanks for your amazing feedback, folks. I've updated the MR, and tried to break it down into saner commits, though the re-formatting and updating the list is still a complicated mess of a commit, unfortunately.

qmonnet commented 5 years ago

PR looks good to me. I haven't been through all the details again of the changes on the README, but new style looks consistent and we can probably fix nits (if any) as follow-up.

Licence file looks good to me. Nice to have the yarn.lock update in a separate commit!

zoidyzoidzoid commented 5 years ago

Awesome, thanks. I'm gonna go ahead and merge it, and we can fix any nit-picks going forward.

Thanks for all the useful feedback folks.