01 Four kinds of contribution
A solution to a cipher already in the ledger
Any target in the catalogue, any write-up marked partial or not solved, and any open item in the notes. Send:
- the target (catalogue number, write-up page or folder name) and the documents covered (shelfmark, folio, DECODE record);
- the key: the sign-to-value table, the code groups you have values for, and the nulls;
- the decipherment, line by line against the ciphertext, with the passages you are unsure of marked;
- how the key was obtained: from the ciphertext alone, from plaintext beside it or elsewhere, from an existing key (whose), or from an existing decipherment. This sets the method shown on the write-up;
- whether the reading was already published anywhere, as far as you know.
A new unsolved cipher
A ciphered document with no known decipherment that is not in the ledger yet. Send:
- the archive, shelfmark and folio, and a link to the images (Gallica, DECODE, the archive’s viewer) or the images themselves if you may share them;
- date, sender and recipient if known, and the language you expect;
- what you know of its status: listed as undeciphered where, any key or decipherment you have looked for;
- a transcription, if you have one. It is not required.
A new cipher with its solution
Both of the above: the document, then the key, the decipherment and how you obtained them. Results that have never been published are welcome; say whether they may be shown here in full or only noted.
A verification of a reading already here
The verification queue lists the readings whose key was recovered or matched here and that no one outside the project has checked. Take the images and the key from the write-up, decipher a passage yourself (a paragraph is enough), and report:
- which passage, and which images you worked from;
- where your reading agrees with the write-up, and every place it does not;
- any key value you would change, with the evidence.
A check that finds errors is as useful as one that confirms. Both are credited.
02 How to send it
On GitHub. Open an issue with one of the forms at github.com/dbourdeau/cyphersolver/issues/new/choose (solution, new cipher, new cipher with solution, verification), or send a pull request. The repository’s CONTRIBUTING.md explains the folder layout and the files a target keeps.
By email. Not on GitHub? Write to dnbourdeau@gmail.com with the same details and any files. The entry is made for you and credited the same way.
03 How credit works
- On the write-up. The page names every contributor under its outcome line, with what each did: solution, new cipher, verification, key correction, transcription, identification, a pointer to a source, or the key or decipherment the reading used.
- On the contributors page. Credits are added up by person and by kind, each count linking to the write-ups. The top contributors are listed on the front page.
- Your name, your way. Say how you want to be named (full name, initials, a handle) and where your name should link.
- Unpublished work. An earlier solution you never published is noted as unpublished, and shown in full only with your agreement.
- Earlier scholarship. Keys and decipherments taken from editions, archives and databases are credited to their makers too, in a separate list, so living contributors are not ranked against the nineteenth century.
04 What happens next
- The contribution is checked against the images: the key applied to the ciphertext, the decipherment read for sense.
- It is filed in the target’s folder with its key, transcription and notes, given a method and an extent, and written up or added to an existing write-up.
- Where the target is on DECODE, the corrections and the decipherment are queued for the DECODE record, credited to you.
- The ledger also feeds a study of how language models perform against historical ciphers. A result you contributed is marked as yours and is kept out of the model’s figures.
- Tools are your choice, including AI. Say what you used, and check the reading against the images before sending it.