Change background image
  1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.

Automagic changelog generation

Discussion in 'Coding' started by Sabira, Apr 13, 2018.

Tags:
Thread Status:
Not open for further replies.
  1. Sabira

    Sabira Donator

    Hello and welcome to the thread where you can see how to do the autochangelog on github!!!

    The automatic changelog system allows you to quickly generate a changelog without having to deal with any files on your end. All you need to do is type the format correctly somewhere in your pull request's original post.

    The format is as follows:

    Code:
    :cl: your name (optional, autofills from github name if not set here)
    prefix: A short description of your change, preferably with proper capitalisation and punctuation.
    prefix: Another short description, if applicable.
    etc
    etc
    /:cl:
    
    The most commonly used vald changelog prefix tags are as follows:
    • rscadd - Adding a feature
    • rscdel - Removing a feature
    • tweak - Changing an existing feature
    • bugfix - Fixing an intended functionality that is not working, or correcting an oversight - changing something you do not like that is intended is NOT a bugfix.
    • maptweak - Changing something on a map, or adding a new away site.
    • spellcheck - Spelling and grammar fixes.
    Some less used but still valid prefix tags are:
    • balance - A step up from 'tweak', usually reserved for big changes.
    • soundadd - Adding new sounds, usually covered by rscadd unless you're only adding the sounds themselves.
    • sounddel - Ditto as above with rscdel
    • imageadd - Adding new icons; same situation as soundadd - usually you're adding something that uses these icons, so this isn't needed
    • imagedel - Ditto as above
    • experiment - For experimental changes and tests that are intended to be temporary.
    • wip - For works in progress. You probably won't get away with using this one.
    Examples:
    Code:
    :cl: sabiram
    rscadd: Added a new species of goat.
    tweak: Made all goats much stronger.
    maptweak: Goats now spawn on the station randomly.
    spellcheck: Fixed goat being spelled 'gaot'.
    /:cl:
    
    :cl:
    rscdel: Removed functionality where screwdrivers could be used to drive screws.
    bugfix: Fixed screwdrivers icons.
    :/cl:
    
     
    Last edited: Jun 14, 2018
    Dukica, LorenLuke and F-Tang Steve like this.
  2. Sabira

    Sabira Donator

Thread Status:
Not open for further replies.