Want to help?
Help expand the guide - share knowledge and code that can be reused across register-based research projects
This guide is continuously evolving, and many researchers have solved the same classic problems each in their own project - without the code or the experience ever being shared. If we share, we all save time.
There are two kinds of contribution we are especially looking for: knowledge (recurring problems, methods and packages we should cover) and code (concrete, reusable solutions). You do not need anything finished - drafts and good pointers are gold too.
How to contribute
Two ways - pick whichever suits you:
- Email us (easiest): saras@clin.au.dk. Send code, a draft, or just an idea - we’ll add it. You need neither git nor GitHub.
- Open a pull request on GitHub (if you’re comfortable with it): The guide’s source files live in a GitHub repository: github.com/steno-aarhus/registers-guide. Every page in the guide is a
.qmdfile, and the website itself is built automatically from them. A pull request is a proposal of concrete changes to those files that we can review and merge.
How do I send a pull request? (step by step)
A pull request is only a proposal - it is never merged automatically. We are notified, review the change, and merge it only once we have approved it. An outside contributor can therefore propose a change but cannot alter the page directly; only people we have explicitly given write access can merge. So nothing goes live behind our backs.
- Create a (free) GitHub account if you don’t have one.
- Find the file. Every page is a
.qmdfile underda/(Danish) anden/(English), and the filename is shown in the address bar: the page at.../en/09a_forstaa_lpr.htmlis the fileen/09a_forstaa_lpr.qmd(the part before.htmlis the.qmdname, andda/enis the language folder). Just edit whichever language you’re comfortable with; we’ll take care of the other. - Click the pencil icon (“Edit this file”) on the file. If you don’t have write access (outside contributors don’t), GitHub automatically makes a fork - your own copy of the project - and your changes are saved there, not in the original.
- Commit (“Commit changes”) and click “Create pull request”. To add a brand-new page instead, use “Add file” → “Create new file” at the top of the file list - that is sent as a pull request too.
- We review, comment if needed, and merge when it’s ready - and the website updates automatically.
Everything can be done in the browser; you don’t need to install git. If you prefer email, that’s perfectly fine.