Skip to content

Repo Naming Convention

Yujie Liu edited this page Sep 15, 2021 · 4 revisions

Repo name is a simplified form of repo's url, and it should comply with below rules:

  • Assume we have a repo url such like:

    https://github.com/~firstname.lastname/linux-os.linux.perf.perf_work-v5.13.0.git

  • Remove the git server prefix in url and only keep user and repo:

    ~firstname.lastname/linux-os.linux.perf.perf_work-v5.13.0.git

  • Remove any leading symbols and trailing '.git'

    firstname.lastname/linux-os.linux.perf.perf_work-v5.13.0

  • Change '/' and '_' to '-'

    firstname.lastname-linux-os.linux.perf.perf-work-v5.13.0

  • Change '.' which are not in version number to '-'

    firstname-lastname-linux-os-linux-perf-perf-work-v5.13.0

  • Remove keywords such like 'linux', 'kernel' and '0day'

    firstname-lastname-os-perf-perf-work-v5.13.0

  • Remove duplicate words and keep only one of them

    firstname-lastname-os-perf-work-v5.13.0

The final format of repo name is 'firstname-lastname-os-perf-work-v5.13.0'

Clone this wiki locally