11  Contributing

Warning

🚧 This website and documentation is still in very active development and evolving quickly, so content could undergo substantial changes at any time 🚧

11.1 File naming conventions

  • Prefer using lower case letters for the name, e.g. contributing.qmd. But, some files follow a widely-used standard of being all upper case, e.g. README.md.
  • Use either hyphens or underscores to separate words, e.g. contributing.qmd or contributing_record.qmd, but not spaces.
    • Spaces can make things difficult to work with for some systems and programs. For instance, if we want to generate our files into a website, including spaces in the names can make it difficult to generate the URLs for the pages.
  • Prefer simpler, shorter words than longer ones, e.g. contributing.qmd instead of how-to-contribute-to-the-project.qmd.
  • Avoid using special characters, including Danish characters like æ, ø, and å. These can also make things difficult to work with for some systems.
  • Avoid repeating the same word in the file name and the folder name, e.g. contributing/contributing-next-steps.qmd. Instead, use contributing/next-steps.qmd.

11.2 Writing

  • Write content using Markdown and in files with either a .qmd (Quarto Markdown) or .md (Markdown) extension.

11.3 Adding content

  • Put everything on GitHub, either as an Issue, a comment in an Issue, or as files in the GitHub repositories.
  • If text documents that aren’t Markdown-based are added, we’ll (maybe automatically?) convert them to Markdown file and then delete the original file.