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

Create a format standard #9

Open
phrohdoh opened this issue May 15, 2019 · 0 comments
Open

Create a format standard #9

phrohdoh opened this issue May 15, 2019 · 0 comments

Comments

@phrohdoh
Copy link
Member

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)

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

No branches or pull requests

1 participant