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 content to the Contributor's Guide #2360

Open
7 of 22 tasks
jprestop opened this issue Dec 1, 2022 · 1 comment
Open
7 of 22 tasks

Documentation: Add content to the Contributor's Guide #2360

jprestop opened this issue Dec 1, 2022 · 1 comment
Assignees
Labels
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 component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team type: task An actionable item of work

Comments

@jprestop
Copy link
Collaborator

jprestop commented Dec 1, 2022

Describe the Task

A Contributor's Guide outline was created with the Create outline for a MET Contributor's Guide #1774 issue. We must still add content.

See this Planning Document, which contains more information.

Time Estimate

On-going

Sub-Issues

Consider breaking the task down into sub-issues.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

TBD

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 PROJECT 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.
  • 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 Linked 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 type: task An actionable item of work priority: medium Medium Priority 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 Dec 1, 2022
@jprestop jprestop added this to the MET 11.1.0 milestone Dec 1, 2022
@jprestop jprestop self-assigned this Dec 1, 2022
@jprestop jprestop moved this to 📋 Backlog in MET-11.1.0 Development Dec 1, 2022
@JohnHalleyGotway JohnHalleyGotway moved this from 📋 Backlog to 🔖 Ready in MET-11.1.0 Development Jun 15, 2023
@jprestop jprestop moved this to 🔖 Ready in MET-12.0.0 Development Jun 22, 2023
@jprestop jprestop modified the milestones: MET 11.1.0, MET 12.0.0 Jun 22, 2023
@jprestop jprestop changed the title Add content to the Contributor's Guide Documentation: Add content to the Contributor's Guide Nov 1, 2023
@jprestop jprestop modified the milestones: MET-12.0.0, MET-12.1.0 Nov 4, 2024
@JohnHalleyGotway
Copy link
Collaborator

Recommend doing this work during the MET-13.0.0-beta1 (version number naming?) development cycle, likely in mid-2025.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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 component: documentation Documentation issue priority: medium Medium Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
None yet
Development

No branches or pull requests

2 participants