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 link to awesome-brazil-data #970

Closed
wants to merge 1 commit into from

Conversation

juliohm
Copy link

@juliohm juliohm commented May 25, 2017

Thank you for this initiative. I am adding an awesome list of datasets about Brazil that I have started recently. It will gradually increase given more visibility.

@kevva
Copy link

kevva commented May 25, 2017

These are just some of the points that are missing. Please read the contribution guidelines carefully. However, I'm not sure this will make it for now anyway being that the content isn't written in English. See #153.

  • Has been around for at least 30 days.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Has the Awesome badge on the right side of the list heading
  • Has contribution guidelines. The file should be named contributing.md. Casing is up to you.

@juliohm
Copy link
Author

juliohm commented May 25, 2017

Thank you @kevva, I have fixed all the issues as suggested:

  • Added topics
  • Added the awesome badge
  • Added CONTRIBUTING.md

Now I don't understand the problem with localized datasets, could you please elaborate on this issue? The general description of the page is still in English, but the datasets are in Portuguese, because well, this is about Brazil.

@sindresorhus
Copy link
Owner

PR template that was removed. Please read the whole thing.


[Insert URL to the list here]

[Explain what this list is about and why it should be included here]

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.

  • I have read and understood the contribution guidelines and the instructions for creating a list.
  • This pull request has a descriptive title.
    For example, Add Name of List, not Update readme.md or Add awesome list.
  • The entry in the Awesome list should:
    • Include a short description about the project/theme of the list. It should not describe the list itself.
      Example: - [Fish](…) - User-friendly shell., not - [Fish](…) - Resources for Fish..
    • Be added at the bottom of the appropriate category.
  • The list I'm submitting complies with these requirements:
    • 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.
    • It's the result of hard work and the best I could possibly produce.
    • Non-generated Markdown file in a GitHub repo.
    • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
    • Not a duplicate.
    • Only has awesome items. Awesome lists are curations of the best, not everything.
    • Includes a project logo/illustration whenever possible.
      • 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.
    • Has the Awesome badge on the right side of the list heading,
    • Has a Table of Contents section.
      • Should be named Contents, not Table of Contents.
      • Should be the first section in the list.
    • Has an appropriate license.
      • That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
      • If you use a license badge, it should be SVG, not PNG.
    • Has contribution guidelines.
      • The file should be named contributing.md. Casing is up to you.
    • Has consistent formatting and proper spelling/grammar.
      • Each link description starts with an uppercase character and ends with a period.
        Example: - [AVA](…) - JavaScript test runner.
      • Drop all the A / An prefixes in the descriptions.
      • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
    • Doesn't include a Travis badge.
      You can still use Travis for list linting, but the badge has no value in the readme.
  • Go to the top and read it again.

@sindresorhus
Copy link
Owner

Closing since it's less than 30 days old and almost has no content. Lists should also be in English. You can still have a Brazilian version.

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.

3 participants