[OPEN-ILS-DEV] change to submitting release notes w/ features

Bill Erickson erickson at esilibrary.com
Wed May 16 10:27:07 EDT 2012


Hi all,

I wanted to bring to everyone's attention a small, but important change
in process for submitting new features.  From the wiki [1]: 

---
New features should be accompanied by a file in the repository under the
docs/RELEASE_NOTES_NEXT/ directory. The file should be in asciidoc
format and contain enough description to enable the documentation team
to write something coherent about the new functionality. The name of the
file should match the feature. No numbering, etc. is required. With each
release, the contents of this directory will be appended to the release
notes.
---

The goal is to have a location for release notes without concern for
which release the feature will ultimately be included in.  In other
words, no more merge conflicts on RELEASE_NOTES_X_Y.txt (or porting
changes from RELEASE_NOTES_X_Y.txt to RELEASE_NOTES_X_Z.txt after a 
feature misses the cutoff).

Here's an example from Thomas' new_xulrunner branch:

http://git.evergreen-ils.org/?p=working/Evergreen.git;a=blob;f=docs/RELEASE_NOTES_NEXT/new_xulrunner.txt;h=3f887ea8146092404a58b1264b7bee8c79fb169b;hb=9eabb0ea87e0368eec24978cfccef86b99f2e70d

Good hunting^H^H^H^H^H^Hcoding.

-b

[1]
http://evergreen-ils.org/dokuwiki/doku.php?id=contributing&#submitting_code_to_the_project

-- 
Bill Erickson
| Senior Software Developer
| phone: 877-OPEN-ILS (673-6457)
| email: erickson at esilibrary.com
| web: http://esilibrary.com 
| Equinox Software, Inc. / Your Library's Guide to Open Source


More information about the Open-ils-dev mailing list