inkblotty/my-work-action

[Painpoint] Add notes about how to update report contents

Open

#49 opened on Feb 6, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (8 forks)github user discovery
good first issue

Repository metrics

Stars
 (18 stars)
PR merge metrics
 (PR metrics pending)

Description

Context

Users who get reports regularly find it arduous to format additions to the report in order to match style.

Acceptance Criteria

  • Update the text under 1. Review the PR within createPRBodyText like so:
- If you notice missing information, add it in
- If you're adding an issue or PR, feel free to copy this template format:
  - Created/Added Comment to/Reviewed [Issue, Discussion or PR title](url)
  • Update the text within makeGroupsIntoMarkdown > markdownBodyArr like so:
const markdownBodyArr = [
    `<!-- NOTE:\n
This report does not include docs, recordings, or other relevant work performed outside of GitHub. You will need to add in additional context if you want this report to reflect the full context of your work.
\n\n
For context on what queries were run, take a look at your my-work .yml file and the queries used in this report: https://github.com/inkblotty/my-work-action/blob/main/src/queries.ts (`main` branch is linked)
\n\n
 If any content is missing, please add it in using the following format:
Created/Added Comment to/Reviewed [Issue, Discussion or PR title](url)
    -->`,
    `# @${username}'s update for ${formatDate(startDate)} - ${formatDate(
      now
    )}\n\n`,
  ];
  • If any of the above formatting ends up looking funky in your test run, update it to appear nicely formatted
  • Update the tests related to the previous changes

Contributor guide