Guidelines for contributions

20 megtekintés
Ugrás az első olvasatlan üzenetre

Jean-François Bourdon

olvasatlan,
2021. aug. 10. 9:26:232021. 08. 10.
– WhiteboxTools
Would it be possible to provide some guidelines on the main GitHub page of WBT on how contributions to the codebase should be done? It really doesn't need to be as extensive as the guide for QGIS, but just some hints like:
  • When editing a tool, when should the Last Modified date in the header (generally line 5 of each tool) be updated?
  • When creating PR, is there any prefered way to write a title like writing first the same of the tool?
  • Is there any thing specific that is always expected to be seen in the PR description that would facilitate validation?
  • In a PR, should we edit the changelog file or it that something that should only be maintained by WhiteboxGeo staff?
  • Is there any specific way that comments inside the code should be written?
  • Is multiple smaller commits/PR are prefered than only one bigger? (I suppose so...)
  • Example of debugging setup with VS Code
I'm also wondering if there is any set small datasets that could be include in WBT that could also be used for testing purpose... or a code snippet allowing creating from scratch a LAS, SHP or raster. If that second option more preferable, it could be PyQGIS snippets to simplify visualisation of the data.


Jean-François Bourdon

olvasatlan,
2021. aug. 11. 11:38:132021. 08. 11.
– WhiteboxTools
  • Any coding style prefered? Suggested formater/linter to use before doing commits? I saw that Rustfmt and clippy exist but I haven't personally used them yet.
  • Guide on how to write plugins
Válasz mindenkinek
Válasz a szerzőnek
Továbbítás
0 új üzenet