From 3fbc0f3546c3b1dceb01dc01319b7b1e38cce0d3 Mon Sep 17 00:00:00 2001 From: Sherwin-14 Date: Fri, 20 Sep 2024 20:28:07 +0530 Subject: [PATCH 1/3] Added PR examples to Pull Request Template --- .github/pull_request_template.md | 4 ++-- CHANGELOG.md | 7 +++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 95911c4f..c6771991 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -26,7 +26,7 @@ created the PR as a non-draft, don't worry, you can still change it to a draft u before getting started. - [ ] Ensure an issue exists representing the problem being solved in this PR. - [ ] Populate a descriptive title. For example, instead of "Updated README.md", use a - title such as "Add testing details to the contributor section of the README". + title such as "Add testing details to the contributor section of the README".[Click on this to see an example PR](https://github.com/nsidc/earthaccess/pull/763#event-14296896566) - [ ] Populate the body of the pull request with: - A clear description of the change you are proposing. - Links to any issues resolved by this PR with text in the PR description, for @@ -34,7 +34,7 @@ created the PR as a non-draft, don't worry, you can still change it to a draft u [GitHub docs - Linking a pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). - [ ] Update `CHANGELOG.md` with details about your change in a section titled `## Unreleased`. If such a section does not exist, please create one. Follow - [Common Changelog](https://common-changelog.org/) for your additions. + [Common Changelog](https://common-changelog.org/) for your additions.[Click on this to see an example PR](https://github.com/nsidc/earthaccess/pull/763#event-14296896566) - [ ] Update the documentation and/or the `README.md` with details of changes to the earthaccess interface, if any. Consider new environment variables, function names, decorators, etc. diff --git a/CHANGELOG.md b/CHANGELOG.md index 849fa384..1cab9c40 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,6 +26,13 @@ [**@mfisher87**](https://github.com/mfisher87), [**@betolink**](https://github.com/betolink)) +- Added example PR links to pull request template + ([#756](https://github.com/nsidc/earthaccess/issues/756)) + [**@Sherwin-14**](https://github.com/betolink), + [**@mfisher87**](https://github.com/mfisher87) + + + ### Fixed - Removed Broken Link "Introduction to NASA earthaccess" From 3b026a5acd1e1ea9eff0933aa04a2c74f6b75c63 Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Fri, 20 Sep 2024 21:36:07 +0530 Subject: [PATCH 2/3] Update .github/pull_request_template.md with proper link Co-authored-by: Matt Fisher --- .github/pull_request_template.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c6771991..033d3562 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -26,7 +26,8 @@ created the PR as a non-draft, don't worry, you can still change it to a draft u before getting started. - [ ] Ensure an issue exists representing the problem being solved in this PR. - [ ] Populate a descriptive title. For example, instead of "Updated README.md", use a - title such as "Add testing details to the contributor section of the README".[Click on this to see an example PR](https://github.com/nsidc/earthaccess/pull/763#event-14296896566) + title such as "Add testing details to the contributor section of the README". + Example PRs: [#763](https://github.com/nsidc/earthaccess/pull/763) - [ ] Populate the body of the pull request with: - A clear description of the change you are proposing. - Links to any issues resolved by this PR with text in the PR description, for From 26eb63f3659c3e10665d8c9c7ce93ab095e9e1fb Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Fri, 20 Sep 2024 21:36:23 +0530 Subject: [PATCH 3/3] Update .github/pull_request_template.md with proper link Co-authored-by: Matt Fisher --- .github/pull_request_template.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 033d3562..8af03cce 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -35,7 +35,8 @@ created the PR as a non-draft, don't worry, you can still change it to a draft u [GitHub docs - Linking a pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). - [ ] Update `CHANGELOG.md` with details about your change in a section titled `## Unreleased`. If such a section does not exist, please create one. Follow - [Common Changelog](https://common-changelog.org/) for your additions.[Click on this to see an example PR](https://github.com/nsidc/earthaccess/pull/763#event-14296896566) + [Common Changelog](https://common-changelog.org/) for your additions. + Example PRs: [#763](https://github.com/nsidc/earthaccess/pull/763) - [ ] Update the documentation and/or the `README.md` with details of changes to the earthaccess interface, if any. Consider new environment variables, function names, decorators, etc.