Markup/Markdown Consistency about spree-guides HOT 5 CLOSED

Not decreeing anything. These are just my guidelines:

• Model names should always begin with an uppercase letter to distinguish them from the concepts they represent. If we're referencing the class name itself, then that is what should go inside ticks. i.e: "The Product model tracks the different products in your store". Having the namespace is optional.
• Buttons should always reference the correct label, and can optionally have their names quoted. Same goes for links and section names and field names, but not state names.

Bold is used like this:

• attribute_name - Short description of attribute goes here

If we're emphasising anything, that should be italicised.

from spree-guides.

Rails conventions don't seem to be very complete IMHO. I think we'll have
to come up with some of our own. I'm open to anything reasonable. The
ones you proposed earlier plus Radar's comments seem like a good start.

On Sun, May 12, 2013 at 7:30 PM, Ryan Bigg [email protected] wrote:

Not decreeing anything. These are just my guidelines:

• Model names should always begin with an uppercase letter to
  distinguish them from the concepts they represent. If we're referencing the
  class name itself, then that is what should go inside ticks. i.e: "The
  Product model tracks the different products in your store". Having the
  namespace is optional.
• Buttons should always reference the correct label, and can
  optionally have their names quoted. Same goes for links and section names
  and field names, but not state names.

Bold is used like this:

• attribute_name - Short description of attribute goes here

If we're emphasising anything, that should be italicised.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/117#issuecomment-17787487
.

from spree-guides.

I pushed a start to a set of conventions on the README. I want to start going through and standardizing, but I want to make sure what I've written up is acceptable first. I can add more, obviously, but I started with what @radar listed. Is the README the appropriate place, or should we move the conventions to the contributing guide?

from spree-guides.

I think both the README and the guide are good places for it. Put it in both.

On Mon, Jun 3, 2013 at 8:58 AM, Dana Jones [email protected]
wrote:

I pushed a start to a set of conventions on the README. I want to start going through and standardizing, but I want to make sure what I've written up is acceptable first. I can add more, obviously, but I started with what @radar listed. Is the README the appropriate place, or should we move the conventions to the contributing guide?

Reply to this email directly or view it on GitHub:
#117 (comment)

from spree-guides.

This has been started and is working well (it's in the README and the contributing guide), so I'm going to close this issue.

from spree-guides.