Hi,

I was hoping to do a lot of documentation committing in the next month I just 
wanted to check in about  commit sign-off procedure as it relates to 
documentation under 3 scenarios:

1. An author sends me documentation in a format needing to be converted to 
asciidoc. I convert it and commit it to the repository -- Would it be OK for me 
to be the single sign-off on this commit using the commit option to indicate 
that there is an original author and my sign off.
e.g. git commit --author="Original Author <[email protected]>"


2.  I make a few typo fixes or update the upgrade instructions to update 
version  references -- Can these quick fixes be direct commits or do I need an 
additional sign-offs?

3. I author a new section or chapter or do a massive overhaul of a section -- 
In this case, I would create working branch – make changes --  cherry pick 
commit – add pull request in launchpad – wait for review/sign-off – commit to 
main repo (or will someone else do the final commit?).
How many sign-offs should be required for documentation commits? Also, is there 
a time frame for waiting for sign-offs before I can just commit it without 
additional sign-off?


Also if someone adds documentation from a different working branch and asks me 
to pull into the main repo, could I just do the cherry pick and commit to the 
main repo as a single sign-off, or do I follow a longer review process and go 
through launchpad?

My main goals is for documentation to be updated in a timely manner but to also 
follow the proper procedure for commits. I am concerned that we will have fewer 
sign-off persons to test and sign off on documentation changes compared to code 
commits.

Thanks,
Robert


Robert Soulliere, BA (Hons), MLIS
Systems Librarian
Mohawk College Library
[email protected]
Telephone: 905 575 1212 x3936
Fax: 905 575 2011

This E-mail contains privileged and confidential information intended
only for the individual or entity named in the message.  If the reader
of this message is not the intended recipient, or the agent responsible
to deliver it to the intended recipient, you are hereby notified that
any review, dissemination, distribution or copying of this communication
is prohibited.  If this communication was received in error, please
notify the sender by reply E-mail immediately, and delete and destroy
the original message.
_______________________________________________
OPEN-ILS-DOCUMENTATION mailing list
[email protected]
http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation

Reply via email to