Skip to content

Commit

Permalink
docs: add guidelines for writing a meaningful pull request (OSGeo#4197)
Browse files Browse the repository at this point in the history
* 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 <veroandreo@gmail.com>
Co-authored-by: Anna Petrasova <kratochanna@gmail.com>
  • Loading branch information
3 people authored and a0x8o committed Sep 5, 2024
1 parent a7769cb commit 8187d36
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions doc/development/github_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,25 @@ a PR.
Alternatively, you can explore GitHub CLI tool (_gh_) which allows you
to do `git push` and create a PR in one step with `gh pr create -fw`.

## Guidelines for writing a meaningful pull request

A well-written pull request clearly conveys the purpose and impact of the
proposed changes.

### PR Title

The title should be descriptive and clearly summarize the main purpose or change
in the pull request. Start the title with the tool name or a
[keyword](https://github.com/OSGeo/grass/blob/main/utils/release.yml) (e.g.:
`tool name: Add functionality Y for Z`. Keep it short, i.e. aim for concise titles,
typically under 50-60 characters.

### PR Content

A pull request requires an abstract, change details, and more. When you create
the new PR, you are presented with a [template](https://github.com/OSGeo/grass/blob/main/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md)
to help standardize the content.

## After creating a PR

GRASS GIS maintainers will now review your PR.
Expand Down

0 comments on commit 8187d36

Please sign in to comment.