Skip to content

Add issue template for wrapping new module #1629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 4, 2021
Merged

Add issue template for wrapping new module #1629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
90a4f8c
Add issue template for wrapping new module
Nov 22, 2021
a77b84b
Improve formatting
Nov 22, 2021
543d012
Apply suggestions from code review
Nov 22, 2021
92de6df
Add instructions for replacing <module-name>
Nov 22, 2021
70a3e3e
Merge branch 'main' into template-new-module
Dec 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Feature request
name: Feature request - General feature
about: Request the addition of a new feature/functionality
title: ''
labels: feature request
Expand Down
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/module_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Feature request - Wrap new GMT module
about: Request PyGMT wrapper for a GMT module
title: Wrapper for <module-name>
labels: feature request
assignees: ''

---

<!-- Please replace <module-name> in the issue title and the description with the name of the requested module and add the description of the module. -->

**Description of the desired module**:

Implement [`<module-name>`](https://docs.generic-mapping-tools.org/latest/<module-name>.html) which `<insert description of the GMT module>`.

<!-- Please be as detailed as you can in your description. If possible, include an example of how you would like to use this feature (even better if it's a code example). -->


**Are you willing to help implement and maintain this feature?** Yes/No

<!-- Every feature we add is code that we will have to maintain and keep updated. This takes a lot of effort. If you are willing to be involved in the project and help maintain your feature, it will make it easier for us to accept it. -->

**Checklist for wrapping GMT Module**

<!-- Please do not edit this section when submitting pull requests. This checklist will help track progress on wrapping the module. -->

- [ ] 'Initial feature implementation' Pull Request (PR)
- [ ] 'Add missing aliases to module' documentation PR
- [ ] 'Support additional functionality in module' PR (optional)
- [ ] 'Add gallery example for module' documentation PR
- [ ] 'Add tutorial for module' documentation PR (optional)
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Fixes #
- [ ] Add tests for new features or tests that would have caught the bug that you're fixing.
- [ ] Add new public functions/methods/classes to `doc/api/index.rst`.
- [ ] Write detailed docstrings for all functions/methods.
- [ ] If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
- [ ] If adding new functionality, add an example to docstrings or tutorials.
Comment on lines 16 to 18
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like these checklist items could be consolidated and/or reworded to be a bit better. Any suggestions?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. Perhaps the following two could be consolidated to "Try to get all checks passing, including style checks and test coverage."

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.

For the following four, if you want I could add a section to 'Contributing code' for adding new functions/methods/classes (including GMT wrappers) that covers this information such that the checklist is simply 'Follow guide in <link to contributing guide section> if adding a new function/method/class'.

  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@weiji14, since this PR has a few approvals already would you mind if I merged this and worked on your suggestions in a separate PR? That way the other reviewers would not need to re-look at existing work. I have the updates partly done, but realistically won't have time to finish it until at least late next week due to AGU rush, GMT tasks, and planned leave.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, sounds good to me to merge this new issue template first. The Pull Request template does need a bit of a refresh so that can be done in a follow up Pull Request (but please do prioritize AGU first).


**Slash Commands**
Expand Down