search

nsidc / earthaccess

Python Library for NASA Earthdata APIs
https://earthaccess.readthedocs.io/
MIT License
409 stars 81 forks source link

Link to examples of high quality pull requests in the pull request template #756

Open mfisher87 opened 3 months ago

mfisher87 commented 3 months ago

For example, #278 does a great job of providing a complete usage example, and our PR template can guide others to do the same!

Sherwin-14 commented 3 months ago

@mfisher87 Hey, do you have specific opinions on how we can approach this? I Think for solving this we need to have some PR'S that follow rules form PR template and we'll then just have to link to those PR'S.

mfisher87 commented 3 months ago

The hard part is finding those PRs :) I don't know that we'll find one "perfect PR" that ticks all the boxes easily, but maybe we can find PRs that exemplify specific things from the list? For example, we have this checklist item:

  • [ ] 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".

Instead of ... such as "Add testing details ..., we could find a PR with a clear and concise title and use that as the example, and continue to find other PRs that have stellar examples of the other qualities we're looking for. What do you think?

Sherwin-14 commented 3 months ago

I will try to come up with a PR that follows the rubric. I think if we are able to encompass all the rules of the rubric in one single PR that would be great. I know it's the ideal case and it may not be plausible at this point in time but I think we should try!

mfisher87 commented 3 months ago

That sounds great! Thanks for being willing to dive deep on this! :heart:

Sherwin-14 commented 4 weeks ago

That sounds great! Thanks for being willing to dive deep on this! ❤️

@mfisher87 Can we use the PR for backwards compatibility as an Ideal PR?

mfisher87 commented 4 weeks ago

I think so! Based on this comment, which of our PR checklist items do you feel that PR sets a good example for?

Sherwin-14 commented 4 weeks ago

I feel my PR has proper methodology, what I mean by that is that you will have to make changes to CHANGELOG before making a PR which I guess is something that people contributing for the first time might look over. Also I feel I could have done better with some of the titles of my commits but I think they are not too bad(they are descriptive enough). These are some of things I can remember at this point in time.

mfisher87 commented 3 weeks ago

That sounds reasonable! Would you be willing to open a PR to modify our PR template? I'm thinking maybe we could add the example PR links as sub-bullets of the checklist items e.g.

https://github.com/nsidc/earthaccess/blob/bb553e17c98ea3ef4d07316ea651cca02af71713/.github/pull_request_template.md?plain=1#L35-L37