inkblotty/my-work-action

[Painpoint] Add notes about how to update report contents

Open

#49 建立於 2025年2月6日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)TypeScript (8 fork)github user discovery
good first issue

倉庫指標

Star
 (18 star)
PR 合併指標
 (PR 指標待抓取)

描述

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

貢獻者指南