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

Add flying-fpv #2400

Merged
merged 2 commits into from
Jun 20, 2023
Merged

Add flying-fpv #2400

merged 2 commits into from
Jun 20, 2023

Conversation

Matthias84
Copy link
Contributor

https://github.com/Matthias84/awesome-flying-fpv

**Open and DIY RC / FPV hard- and software. This topic is currently not refered and other existing lists are very limited **

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

Requirements for your pull request

  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
  • You have to review at least 2 other open pull requests.
    Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List.
    • Add Swift
    • Add Software Architecture
    • Update readme.md
    • Add Awesome Swift
    • Add swift
    • add Swift
    • Adding Swift
    • Added Swift
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
    • - [iOS](…) - Mobile operating system for Apple phones and tablets.
    • - [Framer](…) - Prototyping interactive UI designs.
    • - [iOS](…) - Resources and tools for iOS development.
    • - [Framer](…)
    • - [Framer](…) - prototyping interactive UI designs
  • Your entry should be added at the bottom of the appropriate category.
  • The title of your entry should be title-cased and the URL to your list should end in #readme.
    • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
  • The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. Instead use #2242 for incubation visibility.
  • Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • The default branch should be named main, not master.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • Mobile operating system for Apple phones and tablets.
    • Prototyping interactive UI designs.
    • Resources and tools for iOS development.
    • Awesome Framer packages and tools.
  • It's the result of hard work and the best I could possibly produce.
    If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
    • awesome-swift
    • awesome-web-typography
    • awesome-Swift
    • AwesomeWebTypography
  • The heading title of your list should be in title case format: # Awesome Name of List.
    • # Awesome Swift
    • # Awesome Web Typography
    • # awesome-swift
    • # AwesomeSwift
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
      • Can be placed centered if the list has a centered graphics header.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of nested lists, preferably none.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Doesn't use hard-wrapping.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.
  • Doesn't include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Go to the top and read it again.

There are some existing linter warnings due to emojis, '...' or quotings that are IMHO pretty ok to me. There are 2..3 lines which don't match the official format, but seem to be essetial for the dedicated headings for readers. I shared the list with others to find whats missing, I guess it's a nice ressource for everyone interested in this topic.
I'm sorry, I spend days to compile my list and fill in my knowledge. I'm ok with polishing it to match awesome style and the setup a linter and to fillin PRs, .... but I just lack the time to contribute even to manage other awesome lists and collect experience points. Feel free to stall this link, but I can't volunteer more than that

@sindresorhus
Copy link
Owner

Thanks for making an Awesome list! 🙌

It looks like you didn't read the guidelines closely enough. I noticed multiple things that are not followed. Try going through the list point for point to ensure you follow it. I spent a lot of time creating the guidelines so I wouldn't have to comment on common mistakes, and rather spend my time improving Awesome.

@Matthias84
Copy link
Contributor Author

@sindresorhus so you ask to fix all the issues that your linter lists up?

@boilerrat
Copy link

boilerrat commented Oct 7, 2022

  • Batteries & Power Control
    Incomplete - items without links or description

image

- Modules section - missing description of openLRSng link - Camera and Gimbals - Open Brushless Gimbal link, incomplete description - Antennas and Trackers section - incomplete links, no description - Checklists - does not link to any actual checklists, with one exception - ID systems

image

Each list item should have a link and a description. This presents as a paragraph not a list Hacking and Hijacking: GPS jamming and GPS spoofing, two separate links on one list item, no description. - Accesoirs Section - incomplete, lack of links and description - Legal Information section, switched to a different language - Forums and Social Media, also switched languages for some parts

@Matthias84
Copy link
Contributor Author

Plz see my 1st post. I explain that this lines are to encourage readers to contribute further links to this topics. Other explanations need more than just link+description to explain topics.

Don't get me wrong. Thank you for further explanation, but I don't see why every single line needs to be compliant to what the linter proclaims as valid format ....

@julienrbrt
Copy link
Contributor

I agree as well that the linter should pass.
I think that if you find rules that does not apply to your list, you may just disable the rule for the line: https://github.com/sindresorhus/awesome-lint#ignore

@julienrbrt julienrbrt mentioned this pull request Nov 28, 2022
@Matthias84
Copy link
Contributor Author

Any chance to retrigger the official awesome-lint again in the CI ?

readme.md Outdated
@@ -740,6 +740,7 @@
- [Robotic Tooling](https://github.com/protontypes/awesome-robotic-tooling#readme) - Free and open tools for professional robotic development.
- [LIDAR](https://github.com/szenergy/awesome-lidar#readme) - Sensor for measuring distances by illuminating the target with laser light.
- [Open Hardware](https://github.com/delftopenhardware/awesome-open-hardware#readme) - Open-source hardware projects.
- [Flying FPV](https://github.com/Matthias84/awesome-flying-fpv#readme) - Open hardware and software related to drones / UAVs
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are missing a dot at the end.

@sindresorhus
Copy link
Owner

BLuefish - builds, INAV, longrange.

Typo in the name and builds => Builds.

There are more cases of this. I recommend going through the list and fixing typos and formatting.

@sindresorhus
Copy link
Owner

Descriptions should end with a .

@sindresorhus
Copy link
Owner

Repo description:

curated list of Free software and hardware to build remote controlled copters and planes

"Curated"

"free"

@Matthias84
Copy link
Contributor Author

Hi, thanks for checking. I hope I fixed all the mentioned statements.

Sorry, but I was suprised that awesome-lint didn't discovered this typos:

npx awesome-lint https://github.com/Matthias84/awesome-flying-fpv
✔ Linting

Is there any way to get a full recheck with your official check again and get the report? The Check tab only shows the past run on 08.02. which also succeeded?

@sindresorhus sindresorhus merged commit e75eddb into sindresorhus:main Jun 20, 2023
@sindresorhus
Copy link
Owner

Tweet: https://twitter.com/awesome__re/status/1671144113100423170

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

Successfully merging this pull request may close these issues.

6 participants