Opened 11 months ago
Last modified 11 months ago
#5638 new task
Need some more developer documentation
Reported by: | robe | Owned by: | robe |
---|---|---|---|
Priority: | medium | Milestone: | PostGIS 3.5.0 |
Component: | documentation | Version: | 3.4.x |
Keywords: | Cc: |
Description
strk,
Our upgrade machinery is great. I love what you've done with the replaces comments etc. But I can't find where this is explained.
The closest thing I see to developer documentation we have is
https://git.osgeo.org/gitea/postgis/postgis/src/branch/master/STYLE
I think we need some better developer documentation, and it probably should live in the repo since each new version of PostGIS might add some developer niceties, like your handy replaces construct.
Note sure what this document should be called or if the STYLE guide should be renamed to accommodate how our upgrade plumbing works
I should add this also covers a bit https://postgis.net/development/rfcs/rfc05/ but not quite as detailed as I'd like and I still feel the developer docs should live in the repo, where they can be versioned as our code conventions in our code changes.