Changes between Version 27 and Version 28 of DevWikiDocNewFeature


Ignore:
Timestamp:
Mar 13, 2024, 3:10:44 PM (6 weeks ago)
Author:
robe
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • DevWikiDocNewFeature

    v27 v28  
    22[DevWikiMain Back to PostGIS Dev Main]
    33
    4 If you are submitting a patch for a new feature, keep in mind we only allow new feature patches for semi-major (minor) and major releases, not for micro releases.  So for example if the latest stable version of PostGIS is 3.0.1 and then your new feature must
    5 go into 3.1 (or 3.2 if we've already frozen 3.1 - which happens about 1 month before release).  If you are supplying a bug fix then that can go into the next stable release.  So for example a bug fix for 3.0.0 will go into both 3.0.1 .  A bug fix that fixes further back can be provided for  any release not yet End of Lifed - e.g 3.0, 2.5, 2.4
     4If you are submitting a patch for a new feature, keep in mind we only allow new feature patches for semi-major (minor) and major releases, not for micro releases.  So for example if the latest stable version of PostGIS is 3.4.2 then your new feature must
     5go into 3.5 (or 3.6 if we've already frozen 3.5 - which happens about 1 month before release).  If you are supplying a bug fix then that can go into the next stable release.  So for example a bug fix for 3.4.2 will go into both 3.4.3 .  A bug fix that fixes further back can be provided for  any release not yet End of Lifed - e.g 3.4, 3.3, 3.2, 3.1, 3.0
    66For new features, we expect documentation as part of the submission.  To document a new function, please do the following:
    77  1. Make a copy of  template.xml located in trunk/doc of the PostGIS subversion repository ([https://git.osgeo.org/gitea/postgis/postgis/src/branch/master/doc/template.xml])
     
    1212  3.  Make very sure in the Availability part to note the PostGIS version this is slated for and if it relies on GEOS, the minimum GEOS version required.  This is important so that it gets properly highlighted as new in the documentation and people know which version of GEOS they need to be running to have access to this function.
    1313  4. The refpurpose description is kind of important.  You want it to be short but very meaningful. This is the description that shows on the index pages and also
    14 gets added to (depending on component it is part of) : postgis_comments.sql,topology_comments.sql, raster_comments.sql -- which is what people looking at PgAdminIII or help in psql see.
     14gets added to (depending on component it is part of) : postgis_comments.sql,topology_comments.sql, raster_comments.sql -- which is what people looking at PgAdmin or help in psql see.
    1515
    1616  5.  Name your xml file accordingly e.g. mysuperfunc.xml.