Managing the Specification

In order to update the PFA specification follow these rules:

• When you finish a round of edits, go to Menu -> Versions -> Add Label to say what you've done. By default, Overleaf's version control is too fine-grained, so it is necessary to manually add signposts.
• Use the trackchanges package: (1) add yourself as an editor at the top of the document and (2) make changes or comments using \note, \annote, \add, \remove, and \change. This puts your changes in the margin (like Word), so we can review them by looking at the PDF, rather than diffs of LaTeX source.
• Link your changes to an existing Github Issue.
• The PFA Release Manager will be responsible for merging approved changes and pushing them from Overleaf (the editing copy) to GitHub (the definitive copy).

Here is a read and edit link: use it to edit the document through Overleaf's web interface.

https://www.overleaf.com/4934404dqkwzn

Here is a git-clone commandline for the same repository. Git commit messages don't appear in the web interface, so it's still necessary to do Menu -> Versions -> Add Label.

git clone https://git.overleaf.com/4934404dqkwzn pfa-specification

The trackchanges LaTeX package is documented here:

http://trackchanges.sourceforge.net/

and I've also put relevant examples right above the PFA abstract.

NOTE:

For the library functions, we should find a way to collaboratively edit the libfcns.xml file, which is their source document. Any suggestions on collaboratively editing an XML document? Directly in a GitHub branch? We could break libfcns.xml into smaller files by library (which would be 31 files with vastly different lengths) and word-wrap the text.