diff options
author | Mohammad Akhlaghi <mohammad@akhlaghi.org> | 2021-04-17 04:55:58 +0100 |
---|---|---|
committer | Mohammad Akhlaghi <mohammad@akhlaghi.org> | 2021-04-17 04:55:58 +0100 |
commit | d11725a09133a422dbad19f46caa088bd0bca3a9 (patch) | |
tree | 94ec18b1ff1324837888e3b16025c835f7958f5b /README-hacking.md | |
parent | 30bf4624adf40e9611ad8f6a0214e725b2ea88af (diff) | |
parent | 6e4ec9a305f7021643fe22e08fe0ad17dd363a93 (diff) |
Imported recent work in Maneage, minor conflicts fixed
Some minor conflicts (all expected from the commit messages in the Maneage
branch) occurred but were easily fixed.
Diffstat (limited to 'README-hacking.md')
-rw-r--r-- | README-hacking.md | 34 |
1 files changed, 26 insertions, 8 deletions
diff --git a/README-hacking.md b/README-hacking.md index 92c878e..e42bf42 100644 --- a/README-hacking.md +++ b/README-hacking.md @@ -1050,11 +1050,13 @@ future. information for plain-text data and will put it in the `$(print-general-metadata)` variable. It is thus recommended to print this variable into your plain-text file before printing the actual - data (so it shows on top of the file). If you are publishing your data - in binary formats, please add all the metadata you see in - `$(print-general-metadata)` into each dataset file (for example - keywords in the FITS format). If there are many files, its easy to - define a tiny shell-script to do the job on each dataset. + data (so it shows on top of the file). For a real-world example, see + its usage in `reproduce/analysis/make/delete-me.mk` (in the `maneage` + branch). If you are publishing your data in binary formats, please add + all the metadata you see in `$(print-general-metadata)` into each + dataset file (for example keywords in the FITS format). If there are + many files, its easy to define a tiny shell-script to do the job on + each dataset. - **Link to figure datasets in caption**: all the datasets that go into the plots should be uploaded directly to Zenodo so they can be @@ -1209,15 +1211,31 @@ future. - **After acceptance (before publication)**: Congratulations on the acceptance! The main science content of your paper can't be changed any - more, but the paper will not go to the publication editor (for language + more, but the paper will now go to the publication editor (for language and style). Your approval of the final proof is necessary before the - paper is finally published. Some journals associate your paper's DOI - during this process. So before approving the final proof do these steps: + paper is finally published. Use this period to finalize the final + metadata of your project: the journal's DOI. Some journals associate + your paper's DOI during this process. So before approving the final + proof do these steps: * Add the Journal DOI in `reproduce/analysis/config/metadata.conf`, and re-build your final data products, so this important metadata is added. + * Once you get the final proof, and if everything is OK for you, + implement all the good language corrections/edits they have made + inside your own copy here and commit it into your project. This will + be the final commit of your project before publication. + + * Submit your final project as a new version to Zenodo (and + arXiv). The Zenodo one is most important because your plots will + link to it and you want the commit hash in the data files that + readers will get from Zenodo to be the same hash as the paper. + + * Tell the journal's publication editor to correct the hash and Zenodo + ID in your final proof confirmation (so the links point to the + correct place). Recall that on every new version upload in Zenodo, + you get a new DOI (or Zenodo ID). |