Skip to content

Conversation

@wjr-timmers
Copy link
Collaborator

Pull Request Checklist

General Writing Standards

Voice and Clarity

  • Text is primarily written in active voice
  • Acronyms are written in full at least once on the page where they are used
  • We refer to Handbook topics where possible (e.g. to the Handbook page about Yoda instead of some other information page about Yoda)

Links and Referencing

  • All links use https:// protocol
  • Links are descriptive (avoid "click here" links)
  • For pages with a DOI, link through the DOI (e.g., https://doi.org/10.4444/xxxx)

Images

  • All images have descriptive alt text

Tone and Style

  • Avoid writing in the name of the handbook (no "we recommend")

Topic-Specific Standards

  • Topics are nouns or noun phrases
  • Topics are self-contained and concise
  • Topics are title capitalized
  • No include statements in topics
  • Only use regular markdown (no special Quarto code)
  • Where relevant, assign a suitable category

Guide-Specific Standards

  • Guides are phrased as questions the reader will find answers to
  • Where relevant, guides are assigned a suitable category

Checklist Usage

  • Fill out this checklist when submitting a pull request
  • Automated checks will verify some of these standards, but manual review is still crucial

Note to Contributors: Thank you for helping maintain the quality of our handbook!

@netlify
Copy link

netlify bot commented Jan 12, 2026

Deploy Preview for ub-open-handbook ready!

Name Link
🔨 Latest commit a442601
🔍 Latest deploy log https://app.netlify.com/projects/ub-open-handbook/deploys/6964cc4bb3725a0008d04ff2
😎 Deploy Preview https://deploy-preview-666--ub-open-handbook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 12
Accessibility: 90
Best Practices: 100
SEO: 90
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@peer35 peer35 merged commit 2d35d48 into ubvu:main Jan 22, 2026
6 checks passed
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

Successfully merging this pull request may close these issues.

2 participants