Giter VIP home page Giter VIP logo

repository-naming's Introduction

Guidelines on how to name repositories in GitHub at AITS


Here are some suggested guidelines on how to create repository names that are descriptive and searchable.

Repository names should be use lower case letters and be delimited by dashes


Use 'src' as prefix for source code repositories

src-<language>-<functional area: optional>-<project name>

Some examples using SVN locations:

https://svn.admin.uillinois.edu/svn/aits/ColdFusion/projects/Research/PIPortal ==>> src-cf-research-piportal

https://svn.admin.uillinois.edu/svn/aits/VBNet/projects/AVSL ==>> src-vbnet-avsl

https://svn.admin.uillinois.edu/svn/aits/java/projects/HumanResources/HRFE ==>> src-java-hr-hrfe

Examples: src-java-student, src-java-hrfe, src-cf-nessie, src-net-avsl, etc.


Use 'deploy' as prefix for repositories for deployed artifacts

In SVN a location for HRFrontEnd deployed artifacts would be: /aits/configs/applications/Environments/Test/Applications/hrfe/

Other application types batch, integration, web.

Examples: deploy-nonprod-web-hrfe, deploy-prod-web-hrfe


Use 'proj' as prefix for repositories for projects (not affiliated with source code)

Example: proj-sdlc


Use 'www' as prefix for repositories with web content

Examples: www-banner, www-aits, www-flycmi


Use 'scripts' as prefix for repositories that are primarily to store scripts

Examples: scripts-db, scripts-sqlserver, scripts-kafka


Use 'product' as prefix for repositories containing artifacts for vended products

Examples: product-midpoint, product-banner, product-siteminder


Use 'temp' as prefix for repositories that are used for sandbox purposes

Examples: temp-issues-testing, temp-banner

repository-naming's People

Contributors

jheckel123 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 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.