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

Create ProgressReport-Feb24-Aug24.md #71

Merged
merged 12 commits into from
May 7, 2024
Merged

Conversation

Davsarper
Copy link
Contributor

@Davsarper Davsarper commented Apr 4, 2024

DSH progress report for this month, created a new one as the last one covered a whole year already and it also made it easier to apply format changes and updates.
The idea is to use this file until August.

This report now includes a section for priorities, the idea being that a significant aprt of the Monthly meeting can be asynchronous leaving time together for other discussions.

added missing stories: TRESA
Added missing sotries: PM
added priorities and plans sections
formatted some spacing (spaces after titles)
@Davsarper Davsarper self-assigned this Apr 8, 2024
@Davsarper Davsarper marked this pull request as ready for review April 8, 2024 08:46
@Davsarper Davsarper linked an issue Apr 8, 2024 that may be closed by this pull request
@JimMadge
Copy link
Member

JimMadge commented Apr 8, 2024

Does this supersede #69?

@Davsarper
Copy link
Contributor Author

No, I considered a new file was in order as #69 already covered a whole year. I cleaned up #69, applied changes and recorded outstanding conversations

@JimMadge
Copy link
Member

JimMadge commented Apr 9, 2024

Do you need fresh reviews of that PR then?

Copy link
Member

@JimMadge JimMadge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are quite a few places where the Markdown could be better formatted. Using semantic line breaks helps readability, creating diffs and reviewing.

There are some rules (or conventions) like blank lines before and after lists which some parsers will handle but others won't. It is best to be strict with those to avoid rendering problems. We could add a Markdown linting workflow or pre-commit hook?

Using links instead of writing URLs should make the document look a lot tidier.

There are places where the English could be better. I think shorter sentences are easier to understand. Some of that may be my preference though. Confusion with i.e. and e.g..

Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Apply suggestions from review

Co-authored-by: Jim Madge <[email protected]>
@jemrobinson
Copy link
Member

Not sure where it would live (possibly outreach/comms?), but we should mention HDR UK. @harisood and I gave talks and @harisood was also a panel chair.

@Davsarper
Copy link
Contributor Author

Thanks for that review @JimMadge ! Will get on with that.

There are quite a few places where the Markdown could be better formatted. Using semantic line breaks helps readability, creating diffs and reviewing.

Applied the suggested ones and will review for more.

There are some rules (or conventions) like blank lines before and after lists which some parsers will handle but others won't. It is best to be strict with those to avoid rendering problems. We could add a Markdown linting workflow or pre-commit hook?

Same, applied and will review. Would be keen to add that workflow

Using links instead of writing URLs should make the document look a lot tidier.

I've heard conflicting feedback on preferences, happy to go either way. URLs are more evident and could be more accesible, links look nicer.

There are places where the English could be better. I think shorter sentences are easier to understand. Some of that may be my preference though. Confusion with i.e. and e.g..

I tend to write quite long sentences (even in Spanish which lends itself better to it), and need a second or third pass to rewrite those but you are right.

@Davsarper
Copy link
Contributor Author

@jemrobinson thanks for mentioning, I will add to comms yeah. But please do add details via suggestions (might have missed it in the weekly but I saw no more info). You too @harisood

In general, please do feel free and encouraged to add/modify things to the report

Copy link
Contributor Author

@Davsarper Davsarper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixing spacing

Reports/ProgressReport-Feb24-Aug24.md Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
@JimMadge
Copy link
Member

https://prettier.io/docs/en/ Could be a good choice for linting. It does formatting and integrates nicely with pre-commit. @Davsarper do you want to open an issue for that?

Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Outdated Show resolved Hide resolved
Reports/ProgressReport-Feb24-Aug24.md Show resolved Hide resolved
commit suggestions from review

Co-authored-by: Arielle-Bennett <[email protected]>
@Davsarper Davsarper requested a review from JimMadge May 3, 2024 14:39
@Davsarper
Copy link
Contributor Author

All conversations resolved, @JimMadge your requested changed should be made already but it still shows them as waiting for those to be addressed, do you need to re-review or have I missed some?

@Davsarper Davsarper merged commit f4b7b1c into main May 7, 2024
@Davsarper Davsarper deleted the Davsarper-new-progress-report branch May 7, 2024 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create monthly report for April and agenda
5 participants