Skip to content
Michael Hucka edited this page Mar 13, 2024 · 9 revisions

Create a new repository using the template

  1. Please follow the steps in this GitHub page to create a new GitHub repository from this template repository.
  2. Modify the README.md file as needed for your project.
  3. Delete the original codemeta.json, copy codemeta-TEMPLATE.json to codemeta.json, and fill out as needed.
  4. Change the URL for the issue tracker in the file .github/SECURITY.md to point to your repo's issue tracker.
  5. Change the URL for the issue tracker in the file CONTRIBUTING.md to point to your repo's issue tracker.
  6. Change the URL for the issue tracker in the file SUPPORT.md to point to your repo's issue tracker.
  7. If the repo will not use Python, remove the file INSTALL-Python3.md.
  8. If the repo will not involve Elasticsearch, remove the file INSTALL-Elasticsearch.md.
  9. Go to the Settings tab for the repository, select Community Standards from the left-hand sidebar, and click the Enable button for "Repository admins accept content reports".
  10. Go to the Security tab for the repository and click the button Enable vulnerability reporting next to "Private vulnerability reporting". Also enable any other features that may be appropriate, such as code scanning and secret scanning.
  11. Set up an issue template and optionally a pull request template.

Tips for maintaining your repository

  • When you make new releases, write a summary of the changes in CHANGES.md, and update codemeta.json.