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

Change second person references to third person references in METcalcpy User's Guide #315

Open
4 of 21 tasks
lisagoodrich opened this issue Jul 6, 2023 · 0 comments
Open
4 of 21 tasks
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

@lisagoodrich
Copy link
Contributor

Describe the Task

*Run grep for instances of "you" and replace with "the user", for example:
grep you * in METcalcpy/docs/Users_Guide

find . -name ".rst" | xargs egrep -n you
The above command will find all instances of "you" in the current directory and below.
We are using second person (you) references in places, but should be using third person ("the user") instead. METexpress and METviewer documentation was formatted this way..

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

NONE.

Funding Source

Define the source of funding and account keys here or state NONE.

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.
  • 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: medium Medium 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 Jul 6, 2023
@lisagoodrich lisagoodrich added this to the Consider for Next Release milestone Jul 6, 2023
@lisagoodrich lisagoodrich self-assigned this Jul 6, 2023
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
Status: 🟢 Ready
Development

No branches or pull requests

3 participants