Skip to content

Commit

Permalink
DOC: try fix not rendered branches table
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas Günther committed Jun 20, 2023
1 parent b6eef3e commit 734e627
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .pylintrc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ confidence=
# no Warning level messages displayed, use"--disable=all --enable=classes
# --disable=W"
# disable=R0204,C0413,E0401,W1609,W1626,W1617,E1604,W1610,W1606,W1637,W1619,W1615,W1639,W1638,W1612,E1606,W1618,W1630,W1632,I0020,W1622,W1634,W1633,W1640,I0021,E1603,W1635,E1605,W1602,W1614,W1625,W1611,W1604,E1607,W1629,E1602,W1628,W1605,W1608,W1601,W0704,W1607,W1627,W1603,W1624,W1616,W1621,W1623,W1620,E1608,E1601,W1636,W1613
disable=R0204,C0413,E0401,W1637,W1619,W1615,W1639,W1638,W1612,E1606,W1618,W1630,W1632,I0020,W1622,W1634,W1633,W1640,I0021,E1603,W1635,E1605,W1602,W1614,W1625,W1611,W1604,E1607,W1629,E1602,W1628,W1605,W1608,W1601,W0704,W1607,W1627,W1603,W1624,W1616,W1621,W1623,W1620,E1608,E1601,W1636,W1613,C0209,W0212,E1121,W0719,C0103
disable=R0204,C0413,E0401,W1639,W1638,W1612,E1606,W1618,W1630,W1632,I0020,W1622,W1634,W1633,W1640,I0021,E1603,W1635,E1605,W1602,W1614,W1625,W1611,W1604,E1607,W1629,E1602,W1628,W1605,W1608,W1601,W0704,W1607,W1627,W1603,W1624,W1616,W1621,W1623,W1620,E1608,E1601,W1636,W1613,C0209,W0212,E1121,W0719,C0103


[REPORTS]
Expand Down
22 changes: 11 additions & 11 deletions doc/dev.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,17 +97,17 @@ into the dev branch and delete the branch.
Branches
--------

+--------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| Branch name | Description | Purpose | CI (Jenkins) Current behavior | CI (Jenkins) Wishlist | Rules |
+==============+============================+========================================================================================================================================================================================================================================+=============================================================================================================================================================================================+===============================================================================================================================+========================================================================================================================+
| dev | Main development branch | This is where new versions are developed and pull requests are merged to. | Build and test, on success generate http://dev.pygimli.org and merge to master | Test pull requests, build nightly conda packages for test channel | Run pg.test() and make doc before pushing. Tag related issues in commit message. |
+--------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| release | Latest release | This is where releases are "staged". This usually means creating a git tag and manually merging dev into release. Hot fixes and website typos can be directly committed here. | Start in empty workspace, build, test and create documentation after each push. On success, merge into master and update http://www.pygimli.org. | Test "backward compatibility" (e.g., run example scripts from last release with this version). Test on Mac and Windows, too. | Make sure the tag is annotated and the version string is following the principles described below. |
+--------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| master | Latest tested dev | Make sure that if people checkout the repository, they always have a working version. | (represented by http://dev.pygimli.org) | Build pgcore (if necessary) and pygimli conda packages for release. | Never push anything to master! |
+--------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| * | Feature branches | Larger endeavors and major restructuring should happen in dedicated feature branches (or forks), which are eventually merged to dev. This can also be useful if you want to give write access to others to jointly work on a feature. | Automatic testing can be requested ([email protected]). | | Start feature branch from dev. Inform other developers about your develpment (to avoid conflicts and redundant work). |
+--------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+--------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| Branch name | Description | Purpose | CI (Jenkins) Current behavior | CI (Jenkins) Wishlist | Rules |
+==============+============================+========================================================================================================================================================================================================================================+==================================================================================================================================================+==============================================================================================================================+========================================================================================================================+
| dev | Main development branch | This is where new versions are developed and pull requests are merged to. | Build and test, on success generate http://dev.pygimli.org and merge to master | Test pull requests, build nightly conda packages for test channel | Run pg.test() and make doc before pushing. Tag related issues in commit message. |
+--------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| release | Latest release | This is where releases are "staged". This usually means creating a git tag and manually merging dev into release. Hot fixes and website typos can be directly committed here. | Start in empty workspace, build, test and create documentation after each push. On success, merge into master and update http://www.pygimli.org. | Test "backward compatibility" (e.g., run example scripts from last release with this version). Test on Mac and Windows, too. | Make sure the tag is annotated and the version string is following the principles described below. |
+--------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| master | Latest tested dev | Make sure that if people checkout the repository, they always have a working version. | (represented by http://dev.pygimli.org) | Build pgcore (if necessary) and pygimli conda packages for release. | Never push anything to master! |
+--------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| * | Feature branches | Larger endeavors and major restructuring should happen in dedicated feature branches (or forks), which are eventually merged to dev. This can also be useful if you want to give write access to others to jointly work on a feature. | Automatic testing can be requested ([email protected]). | | Start feature branch from dev. Inform other developers about your develpment (to avoid conflicts and redundant work). |
+--------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+

Commit messages
---------------
Expand Down

0 comments on commit 734e627

Please sign in to comment.