Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 4.56 KB

README.md

File metadata and controls

62 lines (41 loc) · 4.56 KB
Raw

Template Docs

Various templates of common documents and files used throughout Monash DeepNeuron's repositories. This includes licenses, templates for issues, contribution guidelines and more.

The files README.md, CONTRIBUTING.md, UNLICENSE and CODE_OF_CONDUCT.md pertain to the functioning of this repository and aren't strictly templates (but can be used as such if deemed useful).

This repository is Unlicensed.

Table of Contents

Templates

README.md

This file acts as an overview of your repository. It is the first thing user view when looking at you repository. It should contain the most vital information pertaining to your project.

  • Basic - A basic README.md template.

LICENSE

This is the projects software license and governs the usage, distribution availability of a software project. Many licenses have info that must be filled in by the software owners such as dates and names.

  • AGPL-3.0 - GNU Affero General Public License, a free copy left license similar to GPL-3.0 but has an addition term to allow users who interact with the licensed software over a network to receive the source for that program.
  • Apache-2.0 - A copyright license allow anyone modify the original source as long as the source retains its original Apache-2.0 license and as the modifications are listed in the distribution of the modified source. Authors of Apache-2.0 licensed source cannot be help liable under this license.
  • BSD-3-Clause - Simple copyright license allow anyone to do whatever they want with BSD 3-Clause license software as long as the software retains it original BSD 3-Clause license. It also states that contributors of the original source cannot be used to endorse derivative works without explicit prior permission.
  • BSL-1.0 - Simple copyright license allow anyone to do whatever they want with BSL-1.0 license software as long as the software retains it original BSL-1.0 license unless distributed as a compiled binary.
  • GPL-2.0 - GNU General Public License Version 2, a free copy left license.
  • GPL-3.0 - GNU General Public License Version 3, a free copy left license similar to GPL-2.0 but with stricter copyleft requirements.
  • LGPL-3.0 - GNU Lesser General Public License Version 3, a free copy left license similar to GPL-3.0 but LGPL-3.0 software is able to be used and modified with non-GPL-3.0 license source as longe as th originally LGPL-3.0 licensed source retains its original license and the LGPL-3.0 source cna be replaced with other source with no effect on the end users usage of the compiled program.
  • MIT - Simple copyright license allow anyone to do whatever they want with MIT license software as long as the software retains it original MIT license. Authors of MIT licensed source cannot be help liable under this license.
  • MPL-2.0 - Mozilla Public License Version 2.0, is a middle ground license that aims to balance the benefits of permissive licenses like MIT and copyleft licenses like GPL-3.0.
  • Unlicense - A license that releases the software into the public domain.

CODE_OF_CONDUCT.md

This file specifies how contributors to this repository must conduct themselves in relation to collaborating with other people.

CONTRIBUTING.md

This file is used to specify the contributing guidelines for a repository.

  • General - Template for contributing guide for any kind of repository (ie. non-specific).
  • mdBook - Template contributing guide for mdBook based repositories.

.gitignore

.gitignore allow you to specify file patterns that should be ignored by Git.

  • all.gitignore - .gitignore with common ignores for many different languages.
  • GitHub .gitignore Repository - This is an archive of many different .gitignore templates specific to different languages and tools.