CONTRIBUTING.md 1.71 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
Contributing
============
Your contributions and thoughts are highly valued.

In order to contribute to the project, you need to request a GitLab account (https://gitlab.tue.nl/).
Permissions for the STEM repositories can then be requested with the STEM-group-admin: m.c.v.turnhout@tue.nl

Note
====
that when you commit code to the ClDlab repository
- everybody from within the university domain can access the ClDlab repository and see your commits
- your code will be released with a GNU Public License, for all eternity ever

For working on/with ClDlab
- when in doubt, work in your own branch
- when in doubt, discuss with the ClDlab-admin (`owner' of the repository): m.c.v.turnhout@tue.nl

Of course:
==========
- Never, EVER, commit passwords or personal information to any repository. They are accessible for *e-ve-ry-one*

- document your code
- add commandline help-functionality to Matlab-functions
- try to make your scripts platform independent (e.g. no hard-coded (back)slashes in file paths in Matlab scripts: use `fullfile' to circumvent that)
- do not break backward compatibility without consulting the owner of the repo
- do not commit personalised settings (file paths, etc) to the repos
- do not commit broken/unfinished scripts to the branch `master'
- do not commit version tags (only the owner should increase version numbers)

Most importantly
================
- KIS[S]: Keep It Simple [Stupid]

and: https://en.wikipedia.org/wiki/Unix_philosophy (yes, really. because... it *works*!)
- Write programs that Do One Thing And Do It Well (DOTaDIW; also Do It Once And Do It Well, or: do not duplicate code.)
- Write programs to work together.
- Write programs to handle text streams, because that is a universal interface.