We welcome contributions to the site that comply with our Code of Conduct.
Please note: This guide and GitHub are places to contribute to the LD Archive Website. If you would like to contribute your materials to the archive you can find out how on our website.
Contributions can come in many forms. From reporting a bug or other issue, requesting a feature, or contributing code.
This site relies on Jekyll and Minimal Mistakes. Your bug or issue might actually rest in those projects.
When reporting an issue, please use the correct template on the issues page. Then complete with as much information as possible. The more information is provided the more efficient the fix will be.
Please only report a bug if you can repeat it. This will make sure the problem is with the site not your own machine or connection.
DO NOT REPORT PROBLEMS WITH KNOWLEDGE COMMONS HERE.
Probelms that should not be reported include:
- Problems logging into Humanities Commons / Knowledge Commons
- Problems with files or incorrect data on Humanities Commons / Knowledge Commons
- Problems, or feature requests for Humanities Commons / Knowledge Commons
- Concerns about / reporting problems with materials.
- Questions about your use of materials in the repository. Contact the rights holder.
If there is a feature you would like or a way of intereacting with the records, please raise an issue. Simply suggest feature request template from the issues page.
Please remember that this site is a way to surface and find materials stored in Humanities / Knowledge Commons. We are distinct from and not associated with that project.
If you find a feature or bug and would like to fix it or suggest a fix, you can create a fork, then complete a pull request. It will be reviewed by the admins, so please make sure you connect it to the issue(s) you are working on.
We have a fairly permissive policy around AI.
DO use AI to:
- Modify code, or
- Generate code, or
- Find bugs, or
- Error check code, or
- Spell check, or
- Grammer check.
DO NOT use AI to:
- Generate content on pages (ie things visitors will see), or
- Change overall tone of the site or a page, or
- Take charge of a whole pipeline, right up to doing your pull request — human review is required.
Remeber, AI is not perfect. Please build and check your code before submitting a pull request.
To make future contributor's lives easier please include comments about the purpose of changes and what they reference. Comments should avoid idioms, and should always comply with our Code of Conduct.
The site is designed to be tested using Docker. You can find instructions here.
Please help keep the site accessible and usable for all visitors. When making changes to content or layout, aim to follow common accessibility best practices such as WCAG 2.1 AA where practical.
Before submitting a pull request, you can check your changes by:
- Reviewing pages with a keyboard only to make sure navigation and interactive elements are reachable and usable.
- Checking that images have descriptive alternative text where needed and that links/buttons use clear, meaningful labels.
- Ensuring headings are structured in a logical order and that text has sufficient contrast against the background.
- Running an automated accessibility audit in your browser, such as Lighthouse or axe DevTools, and addressing any issues it reports.
If you are unsure whether a change is accessible, it is better to ask for review than to assume it is fine.
Thank you for being interested in contributing to the project.