Git Product home page Git Product logo

repo-template's Introduction

repo-template

Generic repo template for Plus3IT repositories

To use this template:

  1. Select the green "Use this template" button, or click here.
  2. Select the repo Owner, give the repo a name, enter a description, select Public or Private, and click "Create repository from template".
  3. Clone the repository and create a new branch.
  4. Configure the following settings on your new repo.
    • GENERAL
      • Features
        • Turn off Wikis, Sponsorships, Discussions, and Projects
      • Pull Requests
        • Turn off Squash Merging
        • Turn off Rebase Merging
        • Turn on Allow Auto-Merge
        • Turn on Automatically delete head branches
      • Pushes
        • Limit how many branches can be updated in a single push: 2
    • COLLABORATORS and TEAMS
      • Manage Access
        • Add relevant team roles, for example
        • tardigrade-admins (Admin)
        • terraform (Write)
        • releasebot (Write)
    • Branches
      • Create Branch Protection rule for main
        • Turn on Require pull request before merging
        • Turn on Require approvals
        • Turn on Dismiss stale pull requests...
      • Required Status Checks
        • As relevant to projects, for example
          • WIP
          • lint/actionlint
          • lint/tardigradelint
          • test / mockstacktest
        • Turn on Do not allow bypassing the above settings
  5. Edit the following files to customize them for the new repository:
    • LICENSE
      • Near the end of the file, edit the date and change the repository name
    • CHANGELOG.template.md
      • Rename to CHANGELOG.md, replacing the repo-template changelog
      • Edit templated items for the new repo
    • .bumpversion.cfg
      • Edit the version number for the new repo, ask team if not sure what to start with
    • README.md
      • Replace contents for the new repo
    • .github/
      • Inspect dependabot and workflow files in case changes are needed for the new repo
  6. Commit the changes and open a pull request

repo-template's People

Contributors

dependabot[bot] avatar mergify[bot] avatar johnricords avatar lorengordon avatar dalerichardson avatar

Watchers

Thomas H Jones II avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.