# HG changeset patch # User František Kučera # Date 1568990782 -7200 # Node ID 04d100709d764b41e6fe4a1680484a5cb7549eef # Parent ecec1b9e6f50c4560dd4adeedee310f78128a45c moving forward to XML format diff -r ecec1b9e6f50 -r 04d100709d76 ssm-en.xhtml --- a/ssm-en.xhtml Fri Sep 20 16:13:25 2019 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,261 +0,0 @@ - - - - - Sane Software Manifesto - - - -

Sane Software Manifesto

- -

<DRAFT> Please note that this is a draft version. Stay tuned for v1.0.0! </DRAFT>

- -

In respect to user freedoms, privacy, liberty, quality, mental health and world peace we create software according to these guidelines.

- -

Free software

- -

Every piece of Sane software is also Free software.
The user has freedom to run the program for any purpose, to study and change it (i.e. has access to the source code under a free software license) and to distribute modified or unmodified copies.
The user controls his/her computer and software and owns the data.
Non-free software can not be trusted.
Must be buildable using free software toolchain (like GNU/Linux + GCC or OpenJDK etc.).
Should not promote non-free (proprietary) software or services.
Copyleft licenses (like GNU GPL or GNU Affero GPL) are strongly recommended because they guarantee software freedoms to every single end-user and prevent possibility that freedom vanishes somewhere in the distribution chain and the user can't benefit from the free software albeit the software is build on originally free source code.
If the software is distributed with a hardware, the hardware must support instalation of independently built software without any restrictions or requirements (e.g. digital signature from the original author).

- -

Documented

At least basic documentation must be released under a free license (GNU FDL is recommended).
Every advertised feature must be properly documented. Undocumented features can not be considered as features from the user/customer point-of-view.
There might be also other documentation/books released under any license and price.
But average software engineer must be able to build and operate the software with just the free (basic) documentation.
There must be a free documentation with description of building and running the software on a fresh operating system installation including description of all dependencies.

- -

Semantic versioning

Semantic versioning is strongly recommended.
Especially when the software is suposed to be used as dependency by others.
If there is a need of some marketing or cool versioning/codenames like Ultrasonic Umbrella or 2016, they should be used in addition to semantic versioning, not instead of it.
Once publicly released, the package must not be changed anymore – if a change (even a small fix) is needed, new version number must be assigned.
- APIs, file formats and protocols might (and usually should) be semanticly versioned independently from the implementation; - in such case, there should be a table documenting which API/format/protocol version matches which implementation version. -

- -

Compatible with itself

Focus on backward compatibility. Newer version should work as a drop-in replacement.
Don't broke things – rather postpone the release date than deliver a faulty product.
Don't remove features unless they are really obsolete, unused or unrepairably broken.
Incompatible changes must be planned and announced in advance.
Upgrade scripts and upgrade documentation must be provided.

- -

Compatible with others

use open standards (protocols, formats) if they exist
define and publish own open standards if needed -
- also standards must be semantically versioned
- should be written in machine readable format (WSDL, WADL, ASN.1, XSD, Diameter dictionary etc.) or at least formal language (Backus–Naur Form, EBNF etc.)
- also configuration should have machine readable description and should be testable by executing a command
-

- -

Modular architecture

larger and multi-purpose software should be divided into smaller modules
modules must have defined dependencies (less = better)
particular modules should be compilable and executable separately
whole system should be compilable (buildable) with only selected modules – must not require compilation or even distribution of all modules, if they are not necessary

- -

Extensible

- -

able to be extended -
- by configuration (RegExp, SQL, XSLT, XPath etc.)
- by scripting (Guile, Bash, Python, Lua, ECMA Script etc.)
- and/or third-party plugins/modules -
  - it should be easy to create a third-party module and plug it in an existing system
  - dependencies needed to write an extension (i.e. header files, API classes/interfaces) should be as small as possible (do not require large codebase to write a mere plug-in); the required dependency should contain just interfaces (method/function signatures) and data structures but no implementation (executable code)
  -
-
there should be public directory of extensions/scripts

- -

Testable

there should be automated build-time complex tests for the package – feed the program with sample input and verify expected output
there should be also automated runtime/postinstall tests – in order to verify that software was installed properly, all required dependencies are met and basic function is guaranteed – the program should report problem during its start (as a warning if it is not fatal), instead of unexpected failures during operation
unit tests are recommended for code parts that are internally complex (algorithms, important business logic) and have simple interfaces
each external interface should contain procedure/function that does nothing important or heavy, is idempotent and returns simple response which proves that the interface (connection) is working (e.g. echo, print version, status or current time); if authentication and authorization mechanisms are present, there should be one procedure/function callable anonymously and one that requires authorization

- -

Safe code and sustainability

correctness, safety and readability is prefered to performance
use strong data typing, declare preconditions and possible exceptions
data structures must be known and well documented – don't use undocumented map keys or properties
code, comments and specification should be written in the same natural language
there should be a dictionary of used terms, so whole team and also users and customers will speak same language
fail fast – errors in the code should be reported during build time or at least on first execution – don't silently continue if given error would lead to failure later in another part of the code – bad weak coupling leads to difficult debugging

- -

Small code footprint

less LOC (resp. complexity) = better
reduce boilerplate and unused code
use code generators (during build process, not to generate code to be manually edited and versioned)

- -

Sane dependencies

avoid NIH and reuse code but also avoid dependency hell
know your dependencies, know why they are required
reduce dependencies to only necessary ones
depend on small and useful libraries – not on bulky application packages or libraries with large transitive dependencies
if dependency on bulky application package is inevitable, add a layer of abstraction – create a generic interface and connector and allow others to replace the bulky package with their own sane implementation
helper tools: -
- if you e.g. use Bash and Perl during the build process, don't add also Python dependency, write it in Perl – or use Python instead of Perl.
- Or if you use Java as your main language, consider not using Python/Perl for scripting and use Java for it
-
if possible, always depend on abstract interfaces, not on particular implementations

- -

Easily auditable

small code footprint and minimal dependencies makes it easy to do security audit
avoid ungrounded refactoring and reformatting – they make mess and noise in the version control system and impede the audit
refactoring/reformatting changesets should be separated from substantive changes

- -

Reproducible builds

builds should be reproducible: same code/version → same binary package
if not, it should be documented, why and how build products mihgt differ, and there should be plan/task to make it reproducible

- -

Trustworthy packages and sources

every released version (binary or source) is cryptographically signed by the authors (GnuPG/OpenPGP is strongly recommended)
if HTTP is supported, HTTPS should also be – the attacker/eavesdropper should not even know what software/package/update is downloaded by the user
the attacker should not be able to suppress updates – the program must not be silent in such case and must warn the user that something possibly nasty and dangerous is happening
releases should be downloadable also (or exclusively) over BitTorrent or other P2P network
there should be also checksums/hashes for every package
source code repository is accessible through an encrypted connection

- -

Network interactions

no network connection is needed during build – build must be possible completely offline, all dependencies must be downloadable and documented including secure hashes or better cryptographic signatures
if dependencies are optionally automatically downloaded during/before build, the packaging system must cryptographically verify that that they are undamaged
avoid unwanted network interactions during runtime – no „call home“ or update-checks without user's explicit consent
if any network connection is used, it must be cryptographically secured against MITM attacks

- -

Localized/internationalized

is is strongly recommended that it should be possible to localize the user interface independently from the original author by writing a language pack
GNU Gettext or other standard framework (like Java resource bundles) should be used
error messages should have assigned unique error codes, so it is possible to find relevant information regardless current locale
data formats and protocols must be language/locale independent -
- e.g. use decimal point instead of comma and no thousand separators for numbers, use standardized date formats
- in general: everything that is expected to be machine-readable or machine-generated must be independent from current locale
-
character encoding: -
- always be aware of it, don't just blindly use current platform's default (because the other side might run on different platform with different default)
- if given software/format/protocol has some default encoding, it must be clearly defined in its specification and this default should not be changed without changing the major version number
- if there is no default, the encoding must be specified in the metadata attached (e.g. protocol headers, extended attributes on filesystem) to the actual data or at least at the begining of the data (like declaration in XML format)
-
the metric system should be used as default

- -

Communication channels

use RSS/Atom or other machine readable format for: -
- security announcements
- new version announcements
- infrastructure outage announcements
- blog, documentation, how-tos etc.
- AFK events (conferences, meetings, hackatons etc.), for calendar data iCal format is strongly recommended
-
mailing list
e-mail/SMTP -
- use TLS
- use DKIM/ADSP
- use signed and encrypted messages (GnuPG or X.509)
- avoid spam and viruses, don't spam the users, don't push them to subscribe your „newsletter“ – always offer also anonymous channel like RSS/Atom
-
Jabber MUC or IRC
discussion forum
don't push users to register at a proprietary social networks resp. at particular company like Facebook – users without such account must not be discriminated – use open and decentralized networks/protocols instead
Q&A tool + FAQ
there should be a second-level internet domain for the project or its team
but don't buy an internet domain if you are not prepared to mainain it for decades – rather use third level domain under some reliable second level domain maintained by a credible group or person – think of that every expired domain helps spammers and scammers and hurts the users
URLs should be as stable as possible (don't broke old links, set up redirections if needed)
the website must be independent and must contain everything needed – any content (JavaScripts, CSS, fonts, images etc.) downloaded from other domains must not be required to browse/use the website
authors should publish their public keys (GnuPG/OpenPGP or X.509)
crpyptographically secured e-mail address or web form for receiving security vulnerabilities report
every security incident must be clearly documented and investigated – don't obscure it

- -

Accept contributions

good quality code contributions with appropriate copyright and patent licenses or assignments should be accepted from anyone
the good quality code is defined by the project and might involve code style, idioms, design patterns, software architecture, required tests, documentation etc.
such requirements and rules should be available to the contributor before he begins; however (especially smaller) projects might communicate such code quality requirements and provide consultations and guidance during the contribution
in order to contribute, it must not be required: -
- to have an account on any particular third party service like particular e-mail or hosting provider
- to sign a contract (which includes accepting Terms and conditions) with any particular third party (e.g. source code hosting provider)
- to sign any political, religious or other proclamation or agree with it
-
in order to contribute, it might be required: -
- to have an e-mail address (but not at particular domain)
- to assign the copyright to the project and grant a free license for all patents relevant to the contribution
-
the project should record all accepted contributions and maintain a public list of all authors/contributors
the contributor must not loose the right to use or distribute the contributed code under any license (of his choice)

- -

Open development – has public:

source code repository (versioning system), not just source code releases
description of the process of accepting external patches
feature/bug tracking system
roadmap of future releases
plan of supported versions/branches
every release/version/branch must clearly declare the status (alpha, beta, prototype, stable, retired, deprecated…)

- - - - \ No newline at end of file diff -r ecec1b9e6f50 -r 04d100709d76 ssm.en.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ssm.en.xml Fri Sep 20 16:46:22 2019 +0200 @@ -0,0 +1,261 @@ + + + + + Sane Software Manifesto + + + +