|
|
# Paper Versioning Scheme
|
|
|
|
|
|
It is good practice to make a tag in the git repository for every paper that you
|
|
|
give out to someone, be it a colleague or an official submission.
|
|
|
|
|
|
I propose the following versioning scheme.
|
|
|
|
|
|
A version number consists of three components Major.Minor.Bugfix
|
|
|
|
|
|
- Major
|
|
|
- The conference or journal the paper is intended for
|
|
|
- Starts at 1
|
|
|
- Increases when the paper is rejected and the paper is submitted to another
|
|
|
conference
|
|
|
- Minor
|
|
|
- The revision of the paper
|
|
|
- Starts at 1
|
|
|
- Increases every time a new version has to be prepared for the conference
|
|
|
- For example, use 1 for blind review, 2 for proceedings and 3 for the final
|
|
|
publication with ISBN and everything
|
|
|
- Bugfix
|
|
|
- Starts at 1
|
|
|
- Increases every time you give the PDF out to somebody
|
|
|
- The tag in the git repository has as comment the reason for the tag
|
|
|
- For example, "to review for Johan"
|
|
|
|
|
|
Examples
|
|
|
|
|
|
- I'm writing a paper for a conference and give a draft version to my supervisor
|
|
|
- This is the first verision I give out to someone else
|
|
|
- It gets tagged with version 1.1.1
|
|
|
- I get suggestions back, continue to work on the paper, and eventually give the
|
|
|
release candidate to another colleague to comment on
|
|
|
- This is the second version that goes out to someone
|
|
|
- It gets tagged with version 1.1.2
|
|
|
- I incorporate the suggestions and submit the paper to the conference,
|
|
|
anonymized for double blind review
|
|
|
- It gets tagged with version 1.1.3
|
|
|
- I notice an error, there is still time to re-upload it. I fix the error,
|
|
|
upload a new version
|
|
|
- It gets tagged with version 1.1.4
|
|
|
- The paper gets accepted and the conference requests a new version, with full
|
|
|
auther information. I prepare the paper and submit it.
|
|
|
- It gets tagged with version 1.2.1
|
|
|
- I notice an error in my email address, fix it, re-upload it
|
|
|
- It gets tagged with version 1.2.2
|
|
|
- After the conference I get the publisher's meta-data and instructions how to
|
|
|
put them in the paper. I do that, and hand it in.
|
|
|
- It gets tagged with version 1.3.1 |