Skip to content

main: CONTRIBUTING note on buid-src for Windows users #4494

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

Merged
merged 2 commits into from
Mar 24, 2025

Conversation

ralfhandl
Copy link
Contributor

@ralfhandl ralfhandl commented Mar 24, 2025

Note callouts apparently can't be within bullet lists.

Moving it to the end of the section.

Note

Note for VS Code users: the local preview nicely renders Note callouts in bullet lists and allows changing the callout title to something other than "Note". This doesn't work in Github.

Tick one of the following options:

  • schema changes are included in this pull request
  • schema changes are needed for this pull request but not done yet
  • no schema changes are needed for this pull request

Note callouts apparently can't be below bullet list items.

Moving it to the end of the section.
@ralfhandl ralfhandl requested review from a team as code owners March 24, 2025 10:35
@ralfhandl ralfhandl added Housekeeping editorial Wording and stylistic issues labels Mar 24, 2025
Copy link
Contributor

@lornajane lornajane left a comment

Choose a reason for hiding this comment

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

I realise I'm nitpicking, but can we put the note at the start of the section, before the user needs the information? Also it looks odd in context where we now have a note, then a heading, then another note right after that.

Copy link
Contributor

@lornajane lornajane left a comment

Choose a reason for hiding this comment

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

Thanks!

@ralfhandl
Copy link
Contributor Author

can we put the note at the start of the section, before the user needs the information?

@lornajane I was wondering that myself, thanks for confirming my doubts!

@lornajane lornajane merged commit b9c0963 into main Mar 24, 2025
4 checks passed
@lornajane lornajane deleted the ralfhandl-main-contributing-note branch March 24, 2025 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Wording and stylistic issues Housekeeping
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants