This project is a directories template for building fast, robust, and adaptable repository with placeholders to replacing (::AUTHOR_NAME::, ::AUTHOR_EMAIL::, ::AUTHOR_WEBSITE::, ::VENDOR_NAME::, ::PROJECT_NAME:: and ::PROJECT_DESCRIPTION::).
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
cfg
doc
res
src
var
CHANGELOG.md
CODE_OF_CONDUCT.md
COMMIT_TEMPLATE.md
CONTRIBUTING.md
ISSUE_TEMPLATE.md
LICENSE.md
PULL_REQUEST_TEMPLATE.md
README.md

README.md

Readme

This publication describes a filesystem skeleton suitable for ::PROJECT_NAME:: package.

Command-line tools for replacing placeholders which are included with this repository are documented here.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this publication are to be interpreted as described in RFC 2119.

Summary

A package MUST use these names for these root-level directories:

If a package has a root-level directory for ... ... then it MUST be named:
command-line executables bin/
configuration files cfg/
documentation files doc/
other resource files res/
source code src/
variables files var/

A package MUST use these names for these root-level files:

If a package has a root-level file for ... ... then it MUST be named:
a log of changes between releases CHANGELOG.md
code of conduct for contributors CODE_OF_CONDUCT.md
commit template COMMIT_TEMPLATE.md
guidelines for contributors CONTRIBUTING.md
issue template ISSUE_TEMPLATE.md
licensing information LICENSE.md
pull request template PULL_REQUEST_TEMPLATE.md
information about the package itself README.md

A package SHOULD include a root-level file indicating the licensing and copyright terms of the package contents.

Root-Level Directories

bin/

If the package provides a root-level directory for command-line executable files, it MUST be named bin/.

This publication does not otherwise define the structure and contents of the directory.

cfg/

If the package provides a root-level directory for configuration files, it MUST be named cfg/.

This publication does not otherwise define the structure and contents of the directory.

doc/

If the package provides a root-level directory for documentation files, it MUST be named doc/.

This publication does not otherwise define the structure and contents of the directory.

res/

If the package provides a root-level directory for other resource files, it MUST be named res/.

This publication does not otherwise define the structure and contents of the directory.

src/

If the package provides a root-level directory for source code files, it MUST be named src/.

This publication does not otherwise define the structure and contents of the directory.

var/

If the package provides a root-level directory for variables files, it MUST be named var/.

This publication does not otherwise define the structure and contents of the directory.

N.b.: This directory MAY be intended as a web server document root. Alternatively, it MAY be that the files will be served dynamically via other code, copied or symlinked to the "real" document root, or otherwise managed so that they become publicly available on the web.

Other Directories

The package MAY contain other root-level directories for purposes not described by this publication.

This publication does not define the structure and contents of the other root-level directories.

Root-Level Files

CHANGELOG

If the package provides a root-level file with a list of changes since the last release or version, it MUST be named CHANGELOG.

It have a lowercase filename extension indicating the file format (md).

This publication does not otherwise define the structure and contents of the file but an template example.

CODE OF CONDUCT

If the package provides a root-level file with code of conduct about the package itself, it MUST be named CODE_OF_CONDUCT.

It have a lowercase filename extension indicating the file format (md).

This publication does not otherwise define the structure and contents of the file but an template example.

COMMIT TEMPLATE

If the package provides a root-level file with commit template about the package itself, it MUST be named COMMIT_TEMPLATE.

It have a lowercase filename extension indicating the file format (md).

This publication does not otherwise define the structure and contents of the file but an template example.

CONTRIBUTING

If the package provides a root-level file that describes how to contribute to the package, it MUST be named CONTRIBUTING.

It have a lowercase filename extension indicating the file format (md).

This publication does not otherwise define the structure and contents of the file but an template example.

ISSUE TEMPLATE

If the package provides a root-level file with issue template about the package itself, it MUST be named ISSUE_TEMPLATE.

It have a lowercase filename extension indicating the file format (md).

This publication does not otherwise define the structure and contents of the file but an template example.

LICENSE

Whereas package consumers might be in violation of copyright law when copying unlicensed intellectual property, the package SHOULD include a root-level file indicating the licensing and copyright terms of the package contents.

If the package provides a root-level file indicating the licensing and copyright terms of the package contents, it MUST be named LICENSE.

It have a lowercase filename extension indicating the file format (md).

This publication does not otherwise define the structure and contents of the file but an template example.

PULL REQUEST TEMPLATE

If the package provides a root-level file with pull request template about the package itself, it MUST be named PULL_REQUEST_TEMPLATE.

It have a lowercase filename extension indicating the file format (md).

This publication does not otherwise define the structure and contents of the file but an template example.

README

If the package provides a root-level file with information about the package itself, it MUST be named README.

It have a lowercase filename extension indicating the file format (md).

This publication does not otherwise define the structure and contents of the file but an template example.

Other Files

The package MAY contain other root-level files for purposes not described in this publication.

This publication does not define the structure and contents of the other root-level files.

Install

Usage

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

Security

If you discover any security related issues, please email ::AUTHOR_EMAIL:: instead of using the issue tracker.

Credits

  • [::AUTHOR_NAME::][link-author]
  • [All Contributors][link-contributors]

License

The MIT License. Please see License File for more information.