docs: add guidelines for writing a meaningful pull request#4197
docs: add guidelines for writing a meaningful pull request#4197veroandreo merged 6 commits intoOSGeo:mainfrom neteler:docs_add_PR_guidelines
Conversation
A well-written pull request (PR) is critical because it not only improves collaboration and efficiency within a project but also helps newcomers to contribute more easily. Fixes #4194
echoix
left a comment
echoix
left a comment
There was a problem hiding this comment.
The general ideas are correct and the text seems fine. Maybe a more thorough linguistic review might be made, but it's enough with this.
|
Do we still need this one if the PR template will be in place? |
|
It seems all information here can be in the template. |
|
In my optinion we do need a minimum of explanations in The new template will be fine but I am frequently trying to onboard new potential contributors. |
|
I'll try so reformulate the discussion of this PR. As this PR is finished, it can be merged any time now, and we will eventually finish the wording discussions of #4207. |
|
Isn't there a middle ground between no documentation and duplicating the template? We could say something like "follow the template". |
Text reduced in b2c202f |
Co-authored-by: Anna Petrasova <[email protected]>
Co-authored-by: Markus Neteler <[email protected]>
* docs: add guidelines for writing a meaningful pull request A well-written pull request (PR) is critical because it not only improves collaboration and efficiency within a project but also helps newcomers to contribute more easily. Fixes OSGeo#4194 * shorten intro text; add link to release.yml * reduce 'PR Content' description * add link to PR template --------- Co-authored-by: Veronica Andreo <[email protected]> Co-authored-by: Anna Petrasova <[email protected]>
* docs: add guidelines for writing a meaningful pull request A well-written pull request (PR) is critical because it not only improves collaboration and efficiency within a project but also helps newcomers to contribute more easily. Fixes OSGeo#4194 * shorten intro text; add link to release.yml * reduce 'PR Content' description * add link to PR template --------- Co-authored-by: Veronica Andreo <[email protected]> Co-authored-by: Anna Petrasova <[email protected]>
* docs: add guidelines for writing a meaningful pull request A well-written pull request (PR) is critical because it not only improves collaboration and efficiency within a project but also helps newcomers to contribute more easily. Fixes OSGeo#4194 * shorten intro text; add link to release.yml * reduce 'PR Content' description * add link to PR template --------- Co-authored-by: Veronica Andreo <[email protected]> Co-authored-by: Anna Petrasova <[email protected]>
* docs: add guidelines for writing a meaningful pull request A well-written pull request (PR) is critical because it not only improves collaboration and efficiency within a project but also helps newcomers to contribute more easily. Fixes #4194 * shorten intro text; add link to release.yml * reduce 'PR Content' description * add link to PR template --------- Co-authored-by: Veronica Andreo <[email protected]> Co-authored-by: Anna Petrasova <[email protected]>
5 participants
A well-written pull request (PR) is critical because it not only improves collaboration and efficiency within a project but also helps newcomers to contribute more easily.
Fixes #4194
Once accepted a similar PR is needed in the grass-addons repo.