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

CC article C++ Core Guidelines (#2110) #2145

Conversation

bartlettroscoe
Copy link
Member

@bartlettroscoe bartlettroscoe commented Aug 25, 2024

Description

EB Member: @ksbeattie

Resolves #2110

PR checklist for files displayed on bssw.io site

  • [Author] @mention the BSSw.io editorial board member @<eb-member-id> in Description above assigned to shepherd your PR.
  • [Author] Add the <issue-id> in the Description above for the associated GitHub Issue.
  • [Author] Ensure wikize_refs.py -i <base>.md is run and commit (if using wikize_refs.py) ... I ran once and then had to manually fix issues with wikzie-refs.py (will not run again)
  • [Author] Inspect the content in the *.md file(s) as rendered in GitHub for this PR.
  • [EB Mem] Assign this PR to the EB member <eb-member-id>.
  • [EB Mem] Assign this PR to the author of the PR <pr-author-id>.
  • [EB Mem] Add one or more Reviewers.
  • [EB Mem] Add label content: <content-type> for the type of contribution.
  • [EB Mem] Add to Project Content Development (see Content Development).
  • [EB Mem] Add meta-data to the *.md file(s) (set Publish: yes).
  • [EB Mem] Add label preview (so PR branch will be merged to 'preview' branch and watch for possible merge failures).
  • [EB Mem] Rebuild preview site and confirm new content is there, renders correctly and is returned in searches.
  • [Author] Make any final changes to the PR based on feedback.
  • [ ] [Author] Ensure wikize_refs.py -i <base>.md is run and commit (if using wikize_refs.py). Can't rebuild, see above
  • [EB Mem] Rebuild preview site and re-confirm content looks correct.
  • [EB Mem] Ensure at least one reviewer signs off on the final changes.
  • [EB Mem] Move the PR to "Ready to Publish" in Content Development.
  • [EB Mem] Leave comment and @mention @betterscientificsoftware/bssw-maint (BSSw Maint) asking to carry out final publication steps.
  • [BSSw Maint] Verify that all needed files are present in the PR (article, images, updates to Site/Homepage.md carousel and/or Site/Announcements/Announcements.md as appropriate).
  • [BSSw Maint] Merge PR. (Should automatically move to "Done" in Content Development.)
  • [BSSw Maint] Verify new contribution shows up on bssw.io as expected.

NOTE:

  • Checklist items prefixed with [Author] are expected to be performed by the author of the PR or can be performed by the author.
  • Checklist items prefixed with [EB Mem] must be performed by a BSSw.io Editorial Board (EB) Member.
  • Checklist items prefixed with [BSSw Maint] must be performed by someone in the @betterscientificsoftware/bssw-maint team (hint: type @, b, s, s, w, -, m to auto-complete to @betterscientificsoftware/bssw-maint).

©2024 The Better Scientific Software (BSSw.io) website. All rights reserved.

* Needed to property format the `[<citation-name>]:` lines

* wikize-refs.py only supports a max of three references inside of a
  <sup></sup> block.

I will commit the wikize-refs.py updated file next.
There is the same off-by-one error with the numbering of these that I will fix
next (and then never run wikize-refs.py again).
* Fix off-by-one generation error

* Remove period at the end of GSL reference that messed up a bunch of things

* Changed order of [9] and [10]

I manually tested these links and they seem to work.
This should be ready to review and hopefully publish with minor corrections.
Now this should be ready for final review and publishing
@bartlettroscoe bartlettroscoe added the preview Merge PR to the 'preview' branch to allow display on preview.bssw.io label Aug 25, 2024
@bartlettroscoe
Copy link
Member Author

The generated page is shown at:

The formatting looks reasonable.

@bartlettroscoe
Copy link
Member Author

@ksbeattie, if you have a minute, could you please look over this and see if you notice any problems?

@rinkug
Copy link
Member

rinkug commented Aug 25, 2024

I had time so I looked at it and its nicely written @bartlettroscoe

@ksbeattie : could you review at the earliest so that we can push it out asap

There were a few issues, including some typos that I noticed when reading over
this again.  Grammarly is not perfect :-(
Copy link
Contributor

@ksbeattie ksbeattie left a comment

Choose a reason for hiding this comment

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

This looks great to me.

@bartlettroscoe
Copy link
Member Author

@betterscientificsoftware/bssw-maint, this should be ready to publish (see above checklist).

@rinkug rinkug merged commit 7b89e2a into betterscientificsoftware:main Aug 27, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content: curated For curated content preview Merge PR to the 'preview' branch to allow display on preview.bssw.io
Projects
Development

Successfully merging this pull request may close these issues.

CC: C++ Core Guidelines
3 participants