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: Improve the Testing documentation #2271

Closed
7 of 22 tasks
jprestop opened this issue Jul 27, 2023 · 0 comments · Fixed by #2272
Closed
7 of 22 tasks

Documentation: Improve the Testing documentation #2271

jprestop opened this issue Jul 27, 2023 · 0 comments · Fixed by #2272
Assignees
Labels
component: testing Software testing 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 Jul 27, 2023

Describe the Task

@jprestop didn't have much knowledge about running pytests and was completely unfamiliar with markers. In reading the documentation on Subsetting Tests by Marker, she found that she still didn't understand how to use the pytests with markers. Research pytest markers and improve the documentation to make it more understandable to other contributors who may have a lack of knowledge about markers.

Time Estimate

<1 day

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

METplus-5.1.0

Funding Source

Split 2792543 and 2702691

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: testing Software testing issue priority: medium Medium Priority type: task An actionable item of work requestor: METplus Team METplus Development Team labels Jul 27, 2023
@jprestop jprestop added this to the METplus-5.1.0 milestone Jul 27, 2023
@jprestop jprestop self-assigned this Jul 27, 2023
@jprestop jprestop linked a pull request Jul 27, 2023 that will close this issue
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: testing Software testing issue priority: medium Medium Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants