Giter VIP home page Giter VIP logo

template-repository's Introduction

Template Repository

A repository set up with the correct settings from which new repositories should be created.

When a new repository is created appropiate personnel should be added to the appropiate roles under the tab "Collaborators & teams" under "Settings". There should at least be one collaborator with the "Admin" permission which should be the relevant module owner if it's a module repository or the most relevant developer if it is a repository for a smaller code base. Additional developers should be given the "Write" permission.

Below follows a template of how the README of projects should look like at bare minimum. The contents of the README should be constantly updated when changes relating to it are made.

Repository Name

A short description of the repository.

Dependencies

A description of what code dependencies the repository has, a specific version of each depencency should also be included. Optimally a link to the dependencies repositories or other documentation should be provided. Should optimally be presented in a bullet point format as shown below:

  • Dependency A v.1.0
  • Dependency B v.1.2

Installation and setup

A description of how the repository is installed and setup to be executed. Preferably presented in a numbered list format as shown below.

  1. Install the program X.
  2. Run the command 'make' in /src/ directory of the project.

Usage

A short example of how the code is used if necessary.

template-repository's People

Contributors

angloth avatar

Watchers

James Cloos 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.