A collection of templates for common files included in FLOSS projects.

René Maya 72c4a7b8eb Init with common floss files		5 år sedan
.gitignore	72c4a7b8eb Init with common floss files	5 år sedan
ChangeLog.org	72c4a7b8eb Init with common floss files	5 år sedan
Conduct.org	72c4a7b8eb Init with common floss files	5 år sedan
Contribute.org	72c4a7b8eb Init with common floss files	5 år sedan
Manifest.org	72c4a7b8eb Init with common floss files	5 år sedan
ReadMe.org	72c4a7b8eb Init with common floss files	5 år sedan
ReadMe_outline.org	72c4a7b8eb Init with common floss files	5 år sedan
Security.org	72c4a7b8eb Init with common floss files	5 år sedan
security.txt	72c4a7b8eb Init with common floss files	5 år sedan

FLOSS files

Collection of sample files common in FLOSS projects.

Format

All documentation related files are written in org-mode. We avoid markdown since not all flavors behave the same way. AFAIK, it's supported by popular git hosted services such as gitlab, gogs, and even github.

ReadMe_outline.org

The ReadMe.org file is the intro to a project. It focuses on building, or running, software from the source code. Use ReadMe_outline.org~ as a template for a projects ~ReadMe.org

Development status

When we first publish a repo, our project may not necessarily be stable. If necessary, add a status note for instance


This software is in alpha stage. It runs, and works at least some of the
time, but use at your own risk.

This software is considered feature complete at version X.X.X.

This software is unmaintained. Use at your own risk.

Security.org

The Security.org file includes the security policy for a FLOSS project.

The Manifest.org keeps a list of all the files required to run a copy of the software.

The security.txt is meant as a web app's security contact details for independent researchers. For more details check out the official Security.txt website

As soon as the project is stable sign every subsequent release. Include all signatures in a directory. Use modern tools such as minisign or signify(1).

ChangeLog.org

The included ChangeLog.org is an example following these guidelines.

Succinct entries meant for
New/occasional contributors, and power users.
Codebase changes.
One entry per version.
Group changes per type.
Latest version first.
Release date (YYYY-MM-DD; ISO8601) next to version.

Types of changes

In order of relevance:

Security fixes, and notices.
Changed existing functionality.
Deprecated features.
Added new features.
Fixed bugs.
Removed features.

Contribute.org

This file includes the basic guidelines for contributing to a project.

Code of conduct

The Contribute.org file includes a code of conduct meant for small projects.

Projects with recurrent contributions should consider adopting the Code of conduct in Conduct.org.

License.org

Although no license has been included don't forget to add one. For help deciding which license suits a project better, check out the Choose a license table. For the license identifiers read the SPDX list.

License

Creative Commons Zero license.

All files in this repo are public domain, unless otherwise noted. No credit and no open licensing of your version is required.