README.md

template-repo

• template-repo
  • Usage
  • Changelog

GitHub Template Repository for ScribeMD

Usage

• As this is a template repository, please refer to creating a repository from a template. Only copy the default branch.
• Perform the following steps in the new repository:
  • Add any appropriate starter workflows.
  • Find and replace references to the repository name.
  • Add any file path patterns that should not be version controlled to .gitignore, such as those created by tools. Not only Git, but most of our tools respect this list. However, you may occasionally find need to explicitly instruct particular tools to ignore particular files if they do not read from .gitignore or do so incorrectly.
  • If you wish to enable automatic version bumps through Commitizen, remove bump: false in .github/workflows/test.yaml.
  • Add any needed development tools with an available asdf plugin to .tool-versions.
  • Add any appropriate pre-commit hooks to .pre-commit-config.yaml, and update default_install_hook_types if introducing a new hook stage. In particular, include all of our custom hooks that befit your toolchain.
  • Specify appropriate MegaLinter flavor in .pre-commit-config.yaml.
  • Adjust MegaLinter configuration in .mega-linter.yaml if necessary to match choices of language, formats, and tooling formats.
  • Add any needed CSpell dictionaries to cspell.config.yaml.
  • Update the LICENSE copyright year(s) if necessary.
  • Update the project name, description, and authors in pyproject.toml.
  • Modify the README.md to document the new repository.
  • Classify your repository with topics, and set the repository description on GitHub.
  • Disable merge commits and squash merging since we use a rebase-based workflow.
  • Configure automatic deletion of head branches when pull requests are merged.
  • Configure organization or repository secrets if needed.
    • Set SLACK_BOT_TOKEN.
    • To obtain the channel IDs, secondary-click on the desired channel in Slack, and select “Copy link” to copy a URL containing the channel ID. Remove the rest of the URL; the secret should only contain the channel ID.
      • Set SLACK_ACTIONS_CHANNEL_ID for GitHub Actions job/workflow results.
      • Set SLACK_ASSIGN_CHANNEL_ID for pull request assignment notifications.
      • Set SLACK_REVIEW_CHANNEL_ID for pull request review requests.
  • Install Forking Renovate or the Mend Renovate app, or self-host Renovate to automate dependency updates.
  • Follow the contributing guide to complete setup.

Changelog

Please refer to CHANGELOG.md.