Changes between Version 78 and Version 79 of DevWikiComitGuidelines

Timestamp:

02/19/22 13:49:14 (3 years ago)

Author:

robe

Comment:

--

DevWikiComitGuidelines

@@ -1 @@
-= RFC-5: PostGIS Committer Guidelines =
+= RFC-5: PostGIS Core Contributor Guidelines =
 
 ||Version:|| 2.0
 ||Author:|| Regina Obe <lr at pcorp dot us>||
-||Last Edited:|| 2019/10/27||
+||Last Edited:|| 2022/02/19||
 ||Status:|| Draft||
 
@@ -10 +10 @@
 
 == Purpose ==
-To formalize source tree access, and specify some guidelines for source committers and patch submitters. 
+To formalize source tree access, and specify some guidelines for primary source committers and patch submitters. 
 
-== Election to Commit Access ==
-Permission for commit source tree access shall be provided to new developers only if accepted by the PostGIS Project Steering Committee. A proposal should be written to the PSC for new committers and voted on normally. It is not necessary to write an RFC document for these votes, a proposal to postgis-dev is sufficient.
+== Election to Core Contributors Group ==
+Permission for write source tree access shall be provided to contributors only if accepted by the PostGIS Project Steering Committee. A proposal should be written to the PSC for new contributors and voted on normally. It is not necessary to write an RFC document for these votes, a proposal to postgis-dev is sufficient. After approval, the approved contributor shall be given write access to the PostGIS source repo and also added to the documentation under the section [https://postgis.net/docs/manual-dev/postgis_introduction.html#credits_core_present Core Contributors Present] 
 
-Removal of commit access should be handled by the same process.
+Removal of write access should be handled by the same process.
 
-The new committer should have demonstrated commitment to PostGIS and knowledge of the PostGIS source code and processes to the committee's satisfaction, usually by reporting bugs, submitting patches, and/or actively participating in the PostGIS mailing list(s).
+The contributor should have demonstrated commitment to PostGIS and knowledge of the PostGIS source code and processes to the committee's satisfaction, usually by reporting bugs, submitting patches, and/or actively participating in the PostGIS mailing list(s).
 
-The new committer should also be prepared to support any new feature or changes that he/she commits to the PostGIS source tree in future releases, or to find someone to which to delegate responsibility for them if he/she stops being available to support the portions of code that he/she is responsible for.
+The contributor should also be prepared to support any new feature or changes in future releases that the contributor commits to the PostGIS source tree, or to find someone to which to delegate responsibility to should the contributor stop being available to support the portions of code the contributor is responsible for.
 
-All committers should also be a member of the postgis-dev mailing list so they can stay informed on policies, technical developments and release preparation.
+All core contributors should also be a member of the postgis-dev mailing list so they can stay informed on policies, technical developments and release preparation.
 
-New committers are responsible for having read, and understood this document. 
+New core contributors are responsible for having read, and understood this document. 
 
 == Code and Documentation Conventions ==
@@ -34 +34 @@
 == Repo Administrator ==
 
-One member of the Project Steering Committee will be designated as the Repo Administrator. That person will be responsible for giving commit access to folks, updating the CREDITS and authors.git file, and other repo related management. 
+One member of the Project Steering Committee will be designated as the Repo Administrator. That person will be responsible for giving write access to folks, updating the CREDITS, and other repo related management. 
 
 Paul Ramsey is currently designated as the Repo Administrator.
-
-**TODO: Is this still true? It is extremely critical that the new committer's user name be added to authors.svn and authors.git before their first commit otherwise the git replication will break.**
 
 == Commit and Bug, Feature Tracking Practices ==
@@ -46 +44 @@
     1. Use meaningful descriptions for commit log entries.
     2. Add a bug reference like "#1232" at the beginning or end of commit log entries when committing changes related to a ticket in Trac. The '#' character enables Trac to create a hyperlink from the changeset to the mentioned ticket. 
-       For small changes where there is no ticket and there is a pull request or patch, reference to these e.g. github/gitlab pull request link is sufficient
+       For small changes where there is no ticket and there is a pull request or patch, reference to these e.g. github/gitlab/gitea pull request link is sufficient
     3. If you are given a patch or pull request from a community person, note their name in both the commit log entry and NEWS file.
     4. To close a ticket or pull request you can add to your commit log  Closes #[xyz]  where xyx is the trac ticket, or  Closes [link to pull request].  Our trac system has a hook to automatically close these on trac and our git mirrors. 
-    5. ** TODO: Not sure this is proper way to reference git** - Similarly adding References #[xyz] will automatically put the commit log notes on the trac ticket. If you forget to add the notes to the commit log, edit the trac ticket and put the notes in - After committing changes related to a ticket in Trac, write the tree and revision in which it was fixed in the ticket description. Such as "Fixed in master ..git hash and in branches/3.0 <githas>". The 'r' character enables Trac to create a hyperlink from the ticket to the changeset.
+    5. Similarly adding References #[xyz] or References [link to pull request] will automatically put the commit log notes on the trac ticket/git pull request. If you forget to add the notes to the commit log, edit the trac ticket/git pull request and put the notes in - After committing changes related to a ticket in Trac, write the tree and revision in which it was fixed in the ticket description. Such as "Fixed in master ..git hash and in branches/3.0 <githas>". The 'r' character enables Trac to create a hyperlink from the ticket to the changeset.
     6. When new enhancements are added or breaking changes are made and completed the related ticket should be added to the NEWS file.
-    7. Changes should not be committed in stable branches without a corresponding bug id in NEWS. Any change worth pushing into the stable version is worth a bug entry.
+    7. Changes should not be committed in stable branches without a corresponding bug id in NEWS. Any change worth pushing into the stable version is worth a bug entry. Bug fixes pushed to stable branches do not need to be noted in the development branch (except during alpha/beta/rc releases) because it is assumed the development branch includes all bug fixes of prior stable versions.
     8. Never commit new features to a stable branch without permission of the PSC or release manager. Normally only fixes should go into stable branches.
-    9. New features go in the main development master.
+    9. New features go in the master branch.
     10. Only bug fixes should be committed to the code during pre-release code freeze, without permission from the PSC or release manager.
-    11. Significant changes to the main development version should be discussed on the postgis-dev list before you make them, and larger changes will require an RFC approved by the PSC.
-    12. Do not create new branches. Feature branches should be created in your own personal repo of choice. Release managers are assumed to have permission to create a branch.
-    13. spike branch (those in the spike/username area are to be used for experimentation or for major code refactoring that will destabilize the master  After such experimentation is deemed stable, this can then be merged into the master after approval from PSC members.  
-    14. When committing new features or significant changes to existing source code, the committer should take reasonable measures to insure that the source code continues to build and work on the most commonly supported platforms (currently Linux, Mac, and Windows), either by testing on those platforms directly, running Buildbot tests, or by getting help from other developers working on those platforms. If new files or library dependencies are added, then the configure.in, Makefile.in and related documentations should be kept up to date.
+    11. Significant changes to the development version, in particular breaking backward-compatibility, should be discussed on the postgis-dev list before you make them, and larger changes will require an RFC approved by the PSC.
+    12. As a general rule, do not create new branches. Feature branches should be created in your own personal repo of choice. Release managers are assumed to have permission to create a branch.  
+    13. When committing new features or significant changes to existing source code, the committer should take reasonable measures to insure that the source code continues to build and work on the most commonly supported platforms (currently Linux, FreeBSD, Mac, and Windows), either by testing on those platforms directly, running CI tests, or by getting help from other developers working on those platforms. If new files or library dependencies are added, then the configure.in, Makefile.in and related documentations should be kept up to date.
     15. After each commit, verify that all the build bots are happy on this page - https://trac.osgeo.org/postgis/ and if their unhappiness is caused by your commit, fix the issue before making any other changes.
 
 == Committer Tracking ==
 
-A list of all project committers will be kept in the main postgis directory in a file called (CREDITS) listing for each committer. This will be the responsibility of the PSC to ensure:
+A list of all core contributors is listed in the manual under the section "Core Contributors Present" in file doc/introduction.xml. This will be the responsibility of the PSC to keep up to date:
 
-    * Userid: the id that will appear in the logs for this person.
     * Full name: the users actual name.
-    * Email address: A current email address at which the committer can be reached. It may be altered in normal ways to make it harder to auto-harvest.
     * A brief indication of areas of responsibility. 
-    * The name of key developers and their area of responsibility should also be  prominently shown in latest release of manual in the doc/introduction.xml file.  
-      This will be the responsibility of the documentation lead (currently Regina Obe) to ensure.
+ 
+This will be the responsibility of the documentation lead (currently Regina Obe) to manage. All stable non-EOL'd documents should list this information for core contributors.
 
 == Relationship with other Projects ==
@@ -79 +74 @@
 
     * postgresql ( https://www.postgresql.org)
-    * geos ( http://geos.osgeo.org)
+    * geos ( https://libgeos.org)
     * proj ( https://proj.org)
     * gdal ( https://gdal.org)
 
-GIS FOSS suites that need testing before PostGIS major release:
+GIS FOSS suites that may be impacted by PostGIS major release:
     * mapserver (https://mapserver.org)
     * geoserver (https://geoserver.org)
@@ -94 +89 @@
 == Legal ==
 
-Committers are the front line gatekeepers to keep the code base clear of improperly contributed code. It is important to the PostGIS users, developers and the OSGeo foundation to avoid contributing any code to the project without it being clearly licensed under the project license.
+Core contributors are the front line gatekeepers to keep the code base clear of improperly contributed code. It is important to the PostGIS users, developers and the OSGeo foundation to avoid contributing any code to the project without it being clearly licensed under the project license.
 
-Generally speaking the key issues are that those providing code to be included in the repository understand that the code will be released under the original GPL license, and that the person providing the code has the right to contribute the code. For the committer themselves understanding about the license is hopefully clear. For other contributors, the committer should verify the understanding unless the committer is very comfortable that the contributor understands the license (for instance frequent contributors).
+Generally speaking the key issues are that those providing code to be included in the repository understand that the code will be released under the original GPL license, and that the person providing the code has the right to contribute the code. The core contributor that accepts and committs the code should verify the understanding of the contributor unless the committer is very comfortable that the contributor understands the license (for instance frequent contributors).
 
 If the contribution was developed on behalf of an employer (on work time, as part of a work project, etc) then it is important that an appropriate representative of the employer understand that the code will be contributed under the GPL license. The arrangement should be cleared with an authorized supervisor/manager, etc.
@@ -104 +99 @@
 All unusual situations need to be discussed and/or documented.
 
-Committers should adhere to the following guidelines, and may be personally legally liable for improperly contributing code to the source repository:
+Core contributors should adhere to the following guidelines, and may be personally legally liable for improperly contributing code to the source repository:
 
     * Make sure the contributor (and possibly employer) is aware of the contribution terms.
     * Code coming from a source other than the contributor (such as adapted from another project) should be clearly marked as to the original source, copyright holders, license terms and so forth. This information can be in the file headers, but should also be added to the project licensing file if not exactly matching normal project licensing.
     * Existing copyright headers and license text should never be stripped from a file. If a copyright holder wishes to give up copyright they must do so in writing to the OSGeo foundation before copyright messages are removed. If license terms are changed it has to be by agreement (written in email is ok) of the copyright holders.
-    * Code with licenses requiring credit, or disclosure to users should be added to /postgis/trunk/LICENSE.TXT.
+    * Code with licenses requiring credit, or disclosure to users should be added to LICENSE.TXT.
     * When substantial contributions are added to a file (such as substantial patches) the author/contributor should be added to the list of copyright holders for the file.
     * If there is uncertainty about whether a change is proper to contribute to the code base, please seek more information from the project steering committee, or the foundation legal counsel. 
     * New contributors and company contributors should be added to the credits in doc/introduction.xml of the latest release of the PostGIS manual.
-    * It is the responsibility of the document lead to ensure when new enhancements are added or breaking changes are made, these are noted in the trunk/NEWS or relevant branch/NEWS as soon as conveniently possible. The note should include the trac # (unless a major feature with many tickets) and contributors to the feature/change. 
+    * It is the responsibility of the document lead to ensure when new enhancements are added or breaking changes are made, these are noted in the relevant branch/NEWS as soon as conveniently possible. The note should include the trac # (unless a major feature with many tickets) and contributors to the feature/change. 
 
 == Bootstrapping ==