Update Software refs page

elifesciences / schematron-wiki

This contains the markdown from gitbook for schematron.

MIT License

2 stars 0 forks source link

Update Software refs page #140

Closed naushinthomson closed 4 years ago

naushinthomson commented 4 years ago

[x] Clarify that if there are RRIDs we don't need to add AQ, and if authors have added a software ref this is fine to leave.

Definition of done

[x] Updates completed
[x] Team reviewed and approved page?

naushinthomson commented 4 years ago

@Melissa37 @bcollins14 @FAtherden-eLife @JGilbert-eLife In light of recent discussions about what we want for software references, can I ask for a re-review of the following sections?:

The What needs to be added? section
The When to add software references section
The action of github-web-test. Do we want to query authors who have cited github repos and not provided version numbers? They probably won't know what we mean if we use the query as it stands - should we specifically ask for which commit they used or not bother?

fred-atherden commented 4 years ago

For 'What needs to be added?', can we change the Mandatory cells for Source and Publisher from 'No' to 'Yes (or Publisher must be entered instead)' and 'Yes (or Source must be entered instead)'?

fred-atherden commented 4 years ago

The action for github-web-test is fine I think. Although, the Author fields in that specific example are not correct, (should be O'Toole A and McCrone JT, based on the repo), but I don't know if the expectation is that Exeter would find out that information, or just leave the author details as they are in this scenario (given that the query has been added).

JGilbert-eLife commented 4 years ago

On the point about host versus publisher - maybe an '(if applicable)' in the bullet pointed list descriptions?

JGilbert-eLife commented 4 years ago

The screenshot with the caption "All the software here needs to be added as software references and cited properly" is probably not terribly useful to a new starter without some highlighting to make clear where the software is in that paragraph.

JGilbert-eLife commented 4 years ago

Agree that the github-web-test action is OK. However, not sure how wide-covering the examples are with regards to distinguishing repos from blog posts.