Skip to content

Getting started with your project

This page provides a starting point for using the skeleton template.

1. Create a new repository

Use the Use this template button on GitHub to generate a new repository from this skeleton. You can also clone this repository manually if you prefer.

2. Customise metadata

  • Edit README.md to describe your project and update the table of folders.
  • Update CITATION.cff with your project’s title, version, authors, DOI and release date.
  • Replace the placeholder contact addresses in CONTRIBUTING.md, CODE_OF_CONDUCT.md and SECURITY.md with your organisation’s contact information.
  • Decide whether the MIT License suits your project; change it if necessary.

3. Enable GitHub Pages

In the repository settings, navigate to the Settings → Pages. Under Build and deployment, set Source = GitHub Actions. The workflow .github/workflows/pages.yml handles deployments automatically.

If you set a custom domain, GitHub will create a CNAME file automatically or you can edit docs/CNAME manually.

4. Add content

Replace the placeholder documentation in this docs/ folder with your own content. You can organise pages into subdirectories if desired; just ensure that the workflow copies all relevant files into _site/.

5. Review settings

Enable security features and branch protection rules in the repository settings【70583929786251†L179-L197】【70583929786251†L210-L219】. Consider enabling Dependabot updates and secret scanning to keep your project safe.