Changelog ((install)) (Best)

class ChangelogEntry: def __init__(self, version, description, type): self.version = version self.date = datetime.date.today() self.description = description self.type = type

"Update user service. Fix login bug. Refactor utils." CHANGELOG

based on a list of features/fixes you provide. Compare popular automated tools for generating changelogs. Let me know which of these would be most helpful! Changelog - Keyword Insights Documentation Compare popular automated tools for generating changelogs

Hyperlinks are oxygen for open source. If you fixed issue #123, link to it. If you merged a PR, link to the contributor's profile. This does two things: If you fixed issue #123, link to it

Every entry must lead with a clear version number and the date of release. Most software projects utilize , which uses a three-part number format: MAJOR.MINOR.PATCH (e.g., v2.1.4 ). MAJOR: Incompatible API changes or breaking overhauls. MINOR: Functionality added in a backward-compatible manner. PATCH: Backward-compatible bug fixes. Standardized Change Categories

The best engineers are not just coders; they are communicators. The CHANGELOG.md is where those two disciplines meet.

Do not copy/paste your Pull Request titles into the CHANGELOG.

8 Comments

  1. Hi Ben,
    Great article and a very comprehensive provisioning guide! Things are moving very fast at snom and the snom 7xx devices (except currently the 715) are now supplied automatically as “Lync ready” and can be easily provisioned straight out of the box. A simple command of text into the Lync Powershell and voila!

    You can find all the details here:
    http://provisioning.snom.com/OCS/BETA/2012-05-09 Native Software Update information TK_JG.pdf

    Regards,
    Jason

  2. Hi Jason, Thanks. It’s good to hear that’s an option, this post was based off a mini customer deployment we had a few months ago…
    (Also can’t wait to test out the upcoming BToE implementation)

    Ben

  3. Hi Ben,

    just stumbled across your great article. Please note the guide still available (now) here:
    http://downloads.snom.com/snomuc/documentation/2012-02-06_Update-Guide-SIP-to-UC.pdf

    is kind of superseded by the fact that for about 2-3 years the carton box FW image (still standard SIP) supports the UC edition documented MS hardcoded ucupdates-r2 record:

    “not registered”: In this state the device uses the static DNS A record ucupdates-r2. as described in TechNet “Updating Devices” under: http://technet.microsoft.com/en-us/library/gg412864.aspx.

    In short: zero-touch with DNS alias or A record is possible. SIP FW will not register but ask for the CAB upload based UC FW and auto-pull it if approved (but only if device was never registered: fresh from box or f-reset).

    btw: the SIP to UC guide was made as temporally workaround, but I guess the XML templates still provide a good start line.

    Also kind of superseded with Lync Inband Support for Snom settings:

    http://www.myskypelab.com/2014/07/lync-snom-configuration-manager.html
    http://www.myskypelab.com/2014/08/lync-snom-phone-manager.html

    another great tool – powershell on steroids with Snom UC & SIP: http://realtimeuc.com/2014/09/invoke-snomcontrol/
    (a must see !)

    Please dont mind if I was a bit advertising.

    Thanks and greetings from Berlin, also to @Nat,
    Jan

  4. Fantastic article! Thanks for sharing. We’ll be transitioning our Snom 760s to provision from Lync shortly.

    Are there any licensing concerns involved?

  5. Thanks Susan,
    From a licensing point of view you need to make sure you have the UC license for the SNOM phones and on the Lync side if you are doing Enterprise Voice need a Plus CAL for the user concerned…

    Hope that helps?

    Ben

  6. Thanks Jan 🙂

  7. Thanks for the licensing info. It helps a lot!

Leave a reply

Your email address will not be published. Required fields are marked *

Work

N-able Head Nerds Logo

Social

Bluesky Logo
LinkedIn Logo

Community

Microsoft MVP Logo
365 Explained Logo
365 Explained Podcast

Legacy User Groups

MS Cloud User Group logo
MSUC Chat Logo
Evolve Conference logo

Publications

Office 365 for IT Pros 2026 book cover
Office 365 for IT Pros book
Sybex MCA Teams Administrator book cover
Sybex MCA Teams Administrator Study Guide