brmlab/hackerbase
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Document more of specification module.

Browse source
This commit is contained in:
Dominik Pantůček 2023-04-19 13:51:53 +02:00
parent 58baf5bb2a
commit 0cd2bd09d7
2 changed files with 16 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

3
doc/formats.md
View file

@ -2,7 +2,8 @@ File Formats
============ ============
This file documents the internal structure of various file formats This file documents the internal structure of various file formats
used. used. Currently the basic format is used for members files and global
configuration.
Members Directory Members Directory
----------------- -----------------

16
doc/specification.md
View file

@ -1,6 +1,9 @@
Organization Specification Organization Specification
========================== ==========================
The specification of how the organization handles membership fees is
completely wrapped inside the specification module.
Modules Modules
------- -------
@ -11,9 +14,18 @@ Modules
This module contains organization specificaiton in an extensible This module contains organization specificaiton in an extensible
format. format.
member-fees-lookup-table
A period lookup table for full and reduced membership fees. Used by
```lookup-member-fees``` and - more specifically -
```lookup-member-fee``` functions in the ```members-fees``` module.
exchange-rates-lookup-table
A period lookup-table for CZK/EUR conversion. Used by the
```lookup-eur-rate``` function in the ```members-payments``` module.
member-suspend-max-months member-suspend-max-months
Determines how many months the member can be suspended before any Determines how many months the member can be suspended before any
action is required. action is required.