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

Add a codechecker view to the register #30

Closed
nuest opened this issue Dec 1, 2020 · 8 comments
Closed

Add a codechecker view to the register #30

nuest opened this issue Dec 1, 2020 · 8 comments
Assignees
Labels
development Development of the register

Comments

@nuest
Copy link
Member

nuest commented Dec 1, 2020

The register could compile a codechecker profile page for each person contributing as a CODECHECKER.

  1. Add a new page https://codecheck.org.uk/register/codechecker/<GH handle> (or better ORCID ?); content:
    • how many codechecks for which types were done (graphic)
    • list of all codechecks as links
    • list of journals/venues for which codechecks were completed
    • link to GitHub profile
    • link to ORCID profile (in correct formatting, see https://info.orcid.org/brand-guidelines/)
    • pull a profile image from GitHub
  2. Design options
    • Use a table just as for the register
    • "cards" would be nice but also more work in markdown.
  3. Add JSON output format, i.e., https://codecheck.org.uk/register/codechecker/0000-0000-0000-0000.json) with machine-readable metadata and a list of certificate IDs per ORCID
  4. To stats.json, add the number of codecheckers.
@nuest nuest added the development Development of the register label Dec 1, 2020
@nuest nuest self-assigned this Dec 1, 2020
@nuest
Copy link
Member Author

nuest commented Feb 9, 2021

The gluedown package might help, if we use Rmd and not just plain Jekyll: https://kiernann.com/gluedown/

@sje30
Copy link
Collaborator

sje30 commented Feb 9, 2021

happy to use Rmd for this, and hence gluedown. re: layout specifics, I'm not sure which is best (what is easiest for now, and if we can easily swap out one for another, does it matter what we choose?)

@nuest
Copy link
Member Author

nuest commented Feb 10, 2021

Right now everything is plain Jekyll, so not using R Markdown is probably easier. Will see, this is not high on the list yet with just the two of us as checkers ;-)

@angelina-momin
Copy link
Collaborator

angelina-momin commented May 29, 2024

@nuest and @sje30 Couple of questions I need to ask about this feature:

  1. Do you want the rendered register tables to have a "codechecker" column or should I leave the rendered registered table as it is?

If you prefer the former how would you like the string to be formatted? Some of the formats I could think of
{codechecker_name} (ORCID: {orcid_id})
{codechecker_name} ({orcid_id})
{orcid_id}
{codechecker_name}

For the formats with the ORCID IDs I can add hyperlinks to the corresponding ORCID pages if you'd like.

  1. Is there a preference on whether to use ORCID ID or GitHub handle for the link?

I personally lean towards the ORCID ID atm.

The codecheck.yaml files only contain the ORCID IDs of the codecheckers but not the GitHub handle. While it may be possible to look up GitHub handles for a specified name using GitHub API it may prove to be tricky for cases where using the full name does not return the correct GitHub handle or there are multiple users with the same full name.

I would suggest creating a separate PR for adding the GitHub handles that I can look into later.

  1. What would you like as the title of the rendered files? Some of the formats I could think of

Register for codechecks by {codechecker_name} (ORCID: {orcid_id})
Register for codechecks by {codechecker_name} ({orcid_id})
Register for codechecks by ORCID ID: {orcid_id}
Register for codechecks by {codechecker_name}

For the last format we could add the ORCID ID as a subtitle.

@nuest
Copy link
Member Author

nuest commented Jun 18, 2024

Re. 1: Leave the register.csv as it is and bring that information in from the codecheck.yml.

Re. 2: ORCID, please. We would like to stay platform independent, who knows what Micro$oft might decide for GH at some point.

Re. 3: codechecks by {codechecker_name} ({orcid_id}) - I think we can drop the "Register for" in this case.

@angelina-momin
Copy link
Collaborator

angelina-momin commented Jun 24, 2024

Closing this issue as the basic feature for this has been merged

@nuest
Copy link
Member Author

nuest commented Jul 17, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development Development of the register
Projects
None yet
Development

No branches or pull requests

3 participants