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.

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

Documentation: Add Python package/dependent library disclaimer in Contributor's Guides #2300

Closed
7 of 21 tasks
jprestop opened this issue Aug 9, 2023 · 0 comments · Fixed by #2782
Closed
7 of 21 tasks
Assignees
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Milestone

Comments

@jprestop
Copy link
Collaborator

jprestop commented Aug 9, 2023

Describe the Task

Create an issue to add notes to the Contributor’s Guides about using packages outside of what is in requirements.txt and external library dependencies with a note that they may not be acceptable on an operational system if they don’t undergo the 1-2 month approval process (e.g. NCO for WCOSS2)

Time Estimate

1 to 3 days of work

Sub-Issues

Consider breaking the task down into sub-issues.

Relevant Deadlines

RC1

Funding Source

2782544

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.
@jprestop jprestop added component: documentation Documentation issue priority: medium Medium Priority type: task An actionable item of work alert: NEED ACCOUNT KEY Need to assign an account key to this issue requestor: METplus Team METplus Development Team labels Aug 9, 2023
@jprestop jprestop added this to the METplus-6.0.0 milestone Aug 9, 2023
@jprestop jprestop self-assigned this Aug 9, 2023
@jprestop jprestop moved this to 🔖 Ready in MET-12.0.0 Development Aug 9, 2023
@jprestop jprestop removed the alert: NEED ACCOUNT KEY Need to assign an account key to this issue label Nov 12, 2024
@jprestop jprestop linked a pull request Nov 12, 2024 that will close this issue
16 tasks
@jprestop jprestop moved this from 🟢 Ready to 🔎 In review in METplus-Analysis-6.0.0 Development Nov 12, 2024
@georgemccabe georgemccabe moved this from 🟢 Ready to 🔎 In review in METplus-Wrappers-6.0.0 Development Nov 12, 2024
@github-project-automation github-project-automation bot moved this from 🟢 Ready to 🏁 Done in MET-12.0.0 Development Nov 12, 2024
@github-project-automation github-project-automation bot moved this from 🔎 In review to 🏁 Done in METplus-Wrappers-6.0.0 Development Nov 12, 2024
@github-project-automation github-project-automation bot moved this from 🔎 In review to 🏁 Done in METplus-Analysis-6.0.0 Development Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
Status: 🏁 Done
Development

Successfully merging a pull request may close this issue.

1 participant