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.

Sign up for GitHub

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

Jump to bottom

Make a small change to the wording around requiring new releases #1316

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Make a small change to the wording around requiring new releases #1316

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/editing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Pre-publication steps:
- Download the proof, check all references have DOIs, follow the links and check the references.
- EditorialBot can help check references with the command `@editorialbot check references`
- Proof-read the paper and ask authors to fix any remaining typos, badly formed citations, awkward wording, etc..
- Ask the author to make a tagged release and archive, and report the version number and archive DOI in the review thread.
- Ask the author to make a tagged release and archive, and report the version number and archive DOI in the review thread. Note that a new release is only necessary if the software changed during the course of the review. In particular, changes to the paper do not require creating a new release.
Copy link
Member

Choose a reason for hiding this comment

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

I suggest to have each sentence on a new line as that improves the git diff down the line.

Suggested change
- Ask the author to make a tagged release and archive, and report the version number and archive DOI in the review thread. Note that a new release is only necessary if the software changed during the course of the review. In particular, changes to the paper do not require creating a new release.
- Ask the author to make a tagged release and archive, and report the version number and archive DOI in the review thread.
Note that a new release is only necessary if the software changed during the course of the review.
In particular, changes to the paper do not require creating a new release.

- Check the archive deposit has the correct metadata (title and author list), and request the author edit it if it doesn’t match the paper.
- Run `@editorialbot set <doi> as archive`.
- Run `@editorialbot set <v1.x.x> as version` if the version was updated.
Expand Down