Skip to content

Changes

Page history
Update NOMAD software and source code release authored by Markus Scheidgen's avatar Markus Scheidgen
Hide whitespace changes
Inline Side-by-side
NOMAD-software-and-source-code-release.md
View page @ bb23fa29
......@@ -18,18 +18,18 @@ make our source code publicly available, clean it up, and license the use of it.
## What source code is going to be released
The basic assumption is that all NOMAD code is on this GITLab (gitlab.rzg.mpg.de).
The list at the bottom list all GITLab projects of the NOMAD organization.
The list at the bottom list all GITLab projects of the NOMAD organisation.
Not all projects are necessary for 3rd parties to make use of NOMAD
(hackatons, forks, coordination projects, etc.). We will remove
unnecessary projects when they are identified.
## Who is responsible
Short answer: You should know if you are responsible for a source code project.
Short answer: **You** should know if you are responsible for a source code project.
Its hard for us to point fingers to specific people due to the ad-hoc nature
of the GITLab use. The list below shows the owners, masters, developers of
each project, if this information was available. The list also shows the
main authors of recent commits. So if you find yourself in this list, please
main authors of recent commits. So if you find **yourself** in this list, please
feel responsible.
## When must this be done
......@@ -42,7 +42,7 @@ Do them as soon as possible and within the next weeks.
## How to release your source code
**This is much simpler than it sounds.**
There are 4 simple steps that you have to take
There are 5 simple steps that you have to take
0. Identify relevant projects
1. Apply a license to your code
......@@ -100,7 +100,7 @@ You can adapt this for the comment format of other source code languages.
### clean up you code
You SHOULD clean up you code and make it something you are proud to show, and declare as yours.
You SHOULD clean up your code and make it something you are proud to show.
For pyhton, [flake8](http://flake8.pycqa.org/en/latest/) (or [pylint](https://www.pylint.org/)) can help standardising the code.
We do not require all things they check, in particular I would *definitely* relax the maximum line length limit, and probably also the variable naming.
......