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 Stacks #2039

Merged
merged 3 commits into from
Jul 29, 2021
Merged

Add Stacks #2039

merged 3 commits into from
Jul 29, 2021

Conversation

pgray-hiro
Copy link
Contributor

@pgray-hiro pgray-hiro commented Jul 1, 2021

https://github.com/friedger/awesome-stacks-chain#readme

This is a list of awesome resources and projects on the Stacks blockchain, maintained by the Stacks community. Stacks is a blockchain project that brings smart contracts to a chain that has native visibility into Bitcoin state. There are many current and in-progress projects against the Stacks chain, and as a community we feel passionate about being included in the Awesome list.

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

PRs reviewed


  • 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 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.
  • 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.

@pgray-hiro
Copy link
Contributor Author

unicorn

@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.

@pgray-hiro
Copy link
Contributor Author

Hi @sindresorhus, I appreciate the feedback, but I've gone over the list multiple times in the past few days (and have again just now), and believe that our list is meeting all of the guidelines set forth in your document. Can you please help me understand where we're not in compliance? Thanks.

@mat7ias
Copy link
Contributor

mat7ias commented Jul 5, 2021

@pgray-hiro
Your PR to the Awesome list doesn't have the correct punctuation "A smart contract platform secured by Bitcoin", needs a punctuation mark (.) at the end.

@mat7ias mat7ias mentioned this pull request Jul 5, 2021
@pgray-hiro
Copy link
Contributor Author

Thanks @mat7ias - this should be resolved now.

@sindresorhus
Copy link
Owner

I would make the intro Stacks Chain is a blockchain anchored by Bitcoin that enables apps, smart contracts, and digital assets. and then linkify Stacks Chain to its website.

I would also like the intro text to be a little bit more verbose. Why is Stacks Chain cool, what problems does it solve, etc.


Consistent and correct naming. For example, Node.js, not NodeJS or node.js.

Applies to "bitcoin", "stx", and maybe more.

@sindresorhus
Copy link
Owner

Why does the title include "Chain"? The Stacks project doesn't use this in its naming.

@pgray-hiro
Copy link
Contributor Author

Thanks for your feedback on the intro text and consistent naming. I will update our list with that in mind.

Why does the title include "Chain"? The Stacks project doesn't use this in its naming.

When we were crafting the list we were concerned about the naming collision with the Awesome Stacks repo for tech stacks, which is already listed in Awesome.re. We thought adding "Chain" to it would help differentiate. That being said, Stacks is the officially used title (without chain). We can change the title if you think the naming collision is acceptable.

@sindresorhus
Copy link
Owner

I think that's fine. They're in different sections and the description clarifies.

@pgray-hiro pgray-hiro changed the title Add Stacks Chain Add Stacks Jul 28, 2021
@pgray-hiro
Copy link
Contributor Author

The changes you requested are merged into the Awesome Stacks repo - here's a quick summary of what we did:

  • Change title from Stacks Chain to Stacks for consistency with the project.
  • Consistency and correctness in naming - STX, Bitcoin, Lightning Network, TypeScript, JavaScript were all identified as either not consistent or not correctly formed.
  • Update the introduction text to include a link to the Stacks website
  • Update the introduction text to include more context on what Stacks is and why it's cool.

@sindresorhus
Copy link
Owner

You also need to enable the issue tracker on the repo.

@sindresorhus sindresorhus merged commit 781e6f2 into sindresorhus:main Jul 29, 2021
@sindresorhus
Copy link
Owner

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