Skip to content

Commit 0007c84

Browse files
Update README to include contribution guidelines (#317)
Added a contribution guideline section to the README.
1 parent 12669a1 commit 0007c84

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# GFModules - Viewer Web
22

33
This viewer application can be used to find patient data and also provides an address book to find organization information.
4+
This app is part of the 'Generieke Functies, lokalisatie en addressering' project of the Ministry of Health,
5+
Welfare and Sport of the Dutch government.
46

57
## Disclaimer
68

@@ -59,3 +61,15 @@ Make sure you build the frontend assets locally first:
5961
```
6062

6163
After this you can access the application at [http://localhost:8500](http://localhost:8500).
64+
65+
## Contribution
66+
67+
As stated in the [Disclaimer](#disclaimer) this project and all associated code serve solely as documentation and
68+
demonstration purposes to illustrate potential system communication patterns and architectures.
69+
70+
For that reason we will only accept contributions that fit this goal. We do appreciate any effort from the
71+
community, but because our time is limited it is possible that your PR or issue is closed without a full justification.
72+
73+
If you plan to make non-trivial changes, we recommend to open an issue beforehand where we can discuss your planned changes. This increases the chance that we might be able to use your contribution (or it avoids doing work if there are reasons why we wouldn't be able to use it).
74+
75+
Note that all commits should be signed using a gpg key.

0 commit comments

Comments
 (0)