iterami/Docs.htm/Standards/Repos

Repo Details:

• Add a website link and include it in the description as well.
• Topics should be used but limited. Must be in alphabetical order.
• Releases: disabled unless required.
• Packages: disabled unless required.
• Environments: enabled.

Issues and Pull Requests:

• Labels that aren't "Bug" or "Enhancement" are removed. Label descriptions are removed.

Settings:

• General:
  • Repo names should include additional information based upon utilized languages:

    Type	Suffix	Topics
    GTK	.gtk	gtk3
    HTM and GitHub Pages	.htm

  • Template repo setting should be enabled for every repo.
  • Default branch is "main", or "gh-pages" after GitHub pages is set up.
  • Social preview is not used.
  • Wikis are disabled and restricted to users with push access.
  • Issues and Pull Requests are enabled.
  • Sponsorships are disabled.
  • Preservation of the repo in the GitHub Archive Program is enabled.
  • Discussions are disabled.
  • Projects are disabled.
  • All types of pull request merges are allowed.
  • Don't suggest to update the pull request branch.
  • Auto-merge is disabled.
  • Don't automatically delete head branches.
  • Don't include Git LFS objects in the archives.
  • Don't limit how many branches can be updated in a single push.
• GitHub Pages is used whenever possible:
  • Actions are enabled for repos that use GitHub Pages.
  • HTTPS is enforced.
  • Links on repo pages must be to github.io links rather than specific domains.

Creating a new GitHub Pages repo:

1. Locally prepare the 1st repo commit.
2. Create the repo on GitHub and make sure its settings match the list in the settings section.
3. Clone the repo locally, add the locally prepared project files, and push them to the "main" branch.
4. Run gh-pages-from-main.sh on the cloned repo. Make "gh-pages" the default branch on GitHub and delete the "main" branch.
5. Add the repo link to various iterami repos:
   • Repos table so that docs, common file usage, and tests can be managed.
   • iterami.github.io so that it may have a link on the index page.
   • RandomRepo.htm so that it may be randomly selected.
   • Scripts iterami-repos-list.sh so that it may be managed in bulk.
6. Update the repo "Description" with an emoji, mention of CC0 license, description of project and type, and a link to it hosted on https://iterami.github.io.
7. Use the GitHub Pages website.
8. Update the repo "Topics" with at least one topic.
9. Include "Environments" in the home page.

Creating a new repo not hosted on GitHub Pages:

1. Locally prepare the 1st repo commit.
2. Create the repo on GitHub and make sure its settings match the list in the settings section.
3. Clone the repo locally, add the locally prepared project files, and push them to the "main" branch.
4. Add the repo link to various iterami repos:
   • Repos table so that docs, common file usage, and tests can be managed.
   • iterami.github.io so that it may have a link on the index page.
   • RandomRepos.htm so that it may be randomly selected.
   • Scripts iterami-repos-list.sh so that it may be managed in bulk.
5. Update the repo "Description" with an emoji, mention of CC0 license, description of project and type, and a link to download the repo as a ".tar.gz" file.
6. Update the repo "Website" with a link to download the repo as a ".tar.gz" file.
7. Update the repo "Topics" with at least one topic.