Skip to content

Create a format standard #9

Description

@phrohdoh

The format standard for this book should be in an in-tree document.

These bullet points are some of the rules I have generally tried to follow so far and believe we should follow going forward. There are undoubtedly more that I can not think of right now.

  • generally 80 columns per line max, with some exceptions:

    • if a single char of punctuation goes over 80 that's fine
    • avoid orphans if at all possible
    • ...
  • links should go at the bottom of the document (see the current README.md as an example)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions