Git Product home page Git Product logo

Comments (5)

jferris avatar jferris commented on July 18, 2024

I think it's nice to have a convention for what the Heroku apps are named (such as "fdn-staging"), so we should rewrite that rule to be cosmetic.

I think the branch prefix is a cosmetic/convention thing. The important thing there is that there's consistency with naming.

Commit message formats are another cosmetic convention. That rule should probably be rewritten.

I agree on moving new project defaults and protocol guidelines out. I'd prefer to have code design guidelines in a separate document. It's nice to be able to read the entire document we have now and know that everything in there is cosmetic. I'd be fine with having them in the same repo if we're willing to have separate files.

I think there are three useful documents we could have here: Style, Protocol, and Best Practices.

from guides.

croaky avatar croaky commented on July 18, 2024

Sounds good on those specific examples.

Sounds good on one repo. How's this for a plan?

  • Rename this style-guide repo to guides.
  • Move style-guide/README.md to guides/style.md.
  • Move protocol repo to guides/protocol.md.
  • Delete protocol repo.
  • Create guides/best-practices.md.
  • Review what remains in development-handbook repo that we haven't covered.
  • Move remaining development-handbook items into appropriate place in guides.
  • Delete development-handbook repo.

from guides.

jferris avatar jferris commented on July 18, 2024

Yeah, I'm in favor of that plan with one addition: there are a few recipe-style things in the development-handbook that we could move to the blog. I left a bunch of comments on the pull request. I'd like feedback from at least one other developer before merging.

from guides.

croaky avatar croaky commented on July 18, 2024

there are a few recipe-style things in the development-handbook that we could move to the blog

Good call. A number of them were blog posts to begin with:

  • font-face.md
  • remote-pair-programming.md

from guides.

croaky avatar croaky commented on July 18, 2024

Closing this issue to focus discussion on #21.

from guides.

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.