Skip to content
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

Jump to bottom

Documentation: Modify Requirements section of the Contributor's Guide #379

Closed
4 of 22 tasks
lisagoodrich opened this issue May 9, 2024 · 0 comments · Fixed by #380
Closed
4 of 22 tasks

Documentation: Modify Requirements section of the Contributor's Guide #379

lisagoodrich opened this issue May 9, 2024 · 0 comments · Fixed by #380
Assignees
@lisagoodrich
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Milestone
METcalcpy-3.0.0

Comments

@lisagoodrich
Copy link
Contributor

lisagoodrich commented May 9, 2024 •
edited
Loading

Describe the Task

Change this section in the Contributor’s Guide to say:

For information about the Python Requirements for METcalcpy, please see the User’s Guide Python Requirements section in the Installation Guide.

In this way, we eliminate duplication and if we decide to do something different in the User's Guide section, we won't need to remember to update the Contributor's Guide section as well.

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1/2 day of work.

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

2792543 NOAA Base

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@lisagoodrich lisagoodrich added component: documentation Documentation issue priority: high High Priority type: task An actionable item of work alert: NEED ACCOUNT KEY Need to assign an account key to this issue alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle requestor: METplus Team METplus Development Team labels May 9, 2024
@lisagoodrich lisagoodrich added this to the METcalcpy-3.0.0 milestone May 9, 2024
@lisagoodrich lisagoodrich self-assigned this May 9, 2024
@lisagoodrich lisagoodrich linked a pull request May 9, 2024 that will close this issue
Feature 379 requirements #380
Merged
15 tasks
@jprestop jprestop added priority: medium Medium Priority and removed alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle priority: high High Priority labels May 13, 2024
jprestop added a commit that referenced this issue May 13, 2024
@jprestop
Per #379, modified the Python requirements section (and modified some…
a8f3ba6 
… additional links)
jprestop added a commit that referenced this issue May 13, 2024
@lisagoodrich @jprestop
Feature 379 requirements (#380)
39b5e3b 
* using a literal include for python requirements

* adding extra sentence

* Per #379,  modified the Python requirements section (and modified some additional links)

---------

Co-authored-by: Julie Prestopnik <jpresto@ucar.edu>
@lisagoodrich lisagoodrich removed the alert: NEED ACCOUNT KEY Need to assign an account key to this issue label May 13, 2024
@georgemccabe georgemccabe changed the title Modify Requirements section of the Contributors's Guide Documentation: Modify Requirements section of the Contributor's Guide Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lisagoodrich lisagoodrich

Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
METplus-Wrappers-6.0.0 Development
Status: ✅ Done
Milestone
METcalcpy-3.0.0
Development

Successfully merging a pull request may close this issue.

Feature 379 requirements dtcenter/METcalcpy
2 participants
@jprestop @lisagoodrich