Skip to content

Instantly share code, notes, and snippets.

@markekraus
Last active May 22, 2020 14:41
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save markekraus/837c5981942cefbf88f99cbe4a54bbfd to your computer and use it in GitHub Desktop.
Save markekraus/837c5981942cefbf88f99cbe4a54bbfd to your computer and use it in GitHub Desktop.
PSConfBook3 Author Expectations

PSConfBook3 Author Expectations

While we want this to be a fun, collaborative, and creative process, we still wish to produce a high-quality book we can all be proud of, and readers will be happy to purchase. Editing large numbers of chapters, each from different authors is a significant effort. We have the following expectations of our authors to ease the editing process and ensure a baseline of quality.

What does the project expect of the authors?

  • The authors must follow our style and writing guidelines we publish in the GitHub repository.
  • The authors must proofread their chapters at least three (3) times before submitting their final draft.
  • The authors must submit their Final Draft by July 31st. Editors will not accept chapters after the deadline.
  • The authors must be reachable by slack, discord, GitHub, or email during the editing process.
  • The authors must yield to editors' discretion.
  • The authors must write in American English. Native English speakers are heavily responsible for their spelling and grammar. Non-native speakers may give their best effort and seek support from editors.
  • The authors should assist each other with git and GitHub issues if they are able.
  • The authors are responsible for the technical accuracy of their chapters.
  • The authors must not plagiarize.
  • The authors must read, understand, and agree to the copyright agreement.
  • The authors must not use copyrighted materials, including images and memes, even if they may fall within creative commons or public domain.
  • The authors must ensure their images are legible in black and white. When images are sent for physical publication, they are converted from color to black and white. Images not using high contrast can be tough to interpret in black and white. Avoid using "dark mode" screenshots and use dark text on light or white backgrounds.
@rgroefer
Copy link

You mention writing guidelines in the first bullet point. Would you please provide a link to the GitHub repository with these guidelines?

@markekraus
Copy link
Author

@rgroefer The guidelines are still being authored and will be available to selected authors in the private repo.

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