[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Health-dev] Coding and documentation requirements
From: |
Luis Falcon |
Subject: |
[Health-dev] Coding and documentation requirements |
Date: |
Tue, 12 Nov 2024 09:16:44 +0000 |
Dear GNU Health hackers
As we are approaching the feature freeze stage for GH HIS 5.0, I want
to make sure that all new developments integrate nicely.
In that sense, from this version onward, we'll be a bit tighter in the
dev requirements. I particularly want to put focus in documentation.
1) Code documentation: Please document the source code (methods,
classes..)
2) Feature documentation: Before the new functionality is released, all
the documentation - with screenshots when relevant -, needs to committed
properly in the "future" branch of the documentation repository in our
Codeberg site.
For each feature, let's create an "issue" on dev5.0. The issue will be
ready for test at the moment that both code and the documentation
is in place. No new features will be added in 5.0 until these premises
are met.
We're so happy to see the development team growing, and with growth
comes even more responsibility. I think these requirements should be
simple to achieve, but please let me know any suggestion that goes into
that direction, and that is, to deliver great features and
documentation at the same time.
Happy hacking
Luis
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Health-dev] Coding and documentation requirements,
Luis Falcon <=