Code Monkey home page Code Monkey logo

Comments (5)

jlengstorf avatar jlengstorf commented on September 25, 2024 1

@SD10 We do require some metadata, but yeah β€” a warning when sites.yml is added is a low-hanging option that should catch most invalid submissions.

from peril-gatsbyjs.

SD10 avatar SD10 commented on September 25, 2024

@shannonbux I don't have a lot of context on the different kinds of showcases here, but is there enough metadata in the PR to determine where it belongs?

At the very minimum, I think you could make peril leave a comment, warning the PR reviewer, whenever the sites.yml file is modified in a PR

from peril-gatsbyjs.

shannonbux avatar shannonbux commented on September 25, 2024

Hi @SD10 and @jlengstorf, I probably don't know enough about what kinds of metadata PR's can contain to answer for sure, but a warning could be a great idea. The warning ought to say something like:
"Go to the URL and make sure this site matches the requirements in the Site Showcase Submission doc"

We've gotten some submissions for things that are actually starters, so that's an example of what is difficult to catch through automation.

from peril-gatsbyjs.

jlengstorf avatar jlengstorf commented on September 25, 2024

Should we enforce a naming convention for starters, e.g. gatsby-starter-*?

from peril-gatsbyjs.

jlengstorf avatar jlengstorf commented on September 25, 2024

Without enforcing some kind of naming convention, this doesn't really seem feasible, especially because some sites might mention what starter they used, which could generate false positives. I'm happy to revisit this later, but for now it seems like a high-effort task that's hard for robots and easy for humans; let's just catch it in PR reviews.

from peril-gatsbyjs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.