-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a change log to the specification #294
Comments
Good idea! When developing the v1 / 2016 REC spec, we used to have a changelog (manually updated, literally in the spec source), but opted eventually to let the git history explain the changes. With work happening on v2, clarifying what precisely is new in v2 versus that previous 2016 REC spec would indeed be helpful. As part of MSE v2 FPWD CfC, there is already some discussion around the SOTD section referring to this at a high level (e.g. this is v2, v1 was REC in 2016). Adding some text around feature areas new in v2 as well as reinforcing the existing 'commit history' link in the header with perhaps a copy of that link inline in the related v1/v2 SOTD text might help. Currently, while many of the changes have been editorial (updates to BSF specs before they were recently split into distinct repos, updating various boilerplate sections' text, and modernizing to current ReSpec usage, for example), both |
See discussion in #294. This updates the Status of this Document section in preparation to publication as First Public Working Draft, highlighting substantive changes made to the spec and pointing people at the list of commits for details.
See discussion in #294. This updates the Status of this Document section in preparation to publication as First Public Working Draft, highlighting substantive changes made to the spec and pointing people at the list of commits for details. (Also fixes a typo in the way the File API was referenced to fix the incorrect duplicate FILEAPI entry that appeared in the informative references at the end of the spec)
See #296 for proposed changes to the Status of This Document section. Listing substantive changes in this section seems good enough to me, especially as plan is to automate publication of WD afterwards whenever a commit gets pushed to the A proper change log section can be useful too, though, e.g. with one entry per "interesting" spec statuses: FPWD, CR snapshots, REC. |
See discussion in #294. This updates the Status of this Document section in preparation to publication as First Public Working Draft, highlighting substantive changes made to the spec and pointing people at the list of commits for details. (Also fixes a typo in the way the File API was referenced to fix the incorrect duplicate FILEAPI entry that appeared in the informative references at the end of the spec)
It would be good for new readers of the spec to understand what has changed in v2 compared to v1. IIUC, only
changeType
has been added so far. Maybe new features/corrections will be made until final publication. It would be good to have a "Change Log" section in the spec.The text was updated successfully, but these errors were encountered: