From 6b632abd441f1810afe90d8857e27922860eee4a Mon Sep 17 00:00:00 2001 From: Petra Baranski Date: Sat, 10 Oct 2020 08:03:21 +0200 Subject: [PATCH] Added CHANGELOG and CONTRIBUTING --- CHANGELOG.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 26 +++++++++++++++++++ README.md | 2 ++ 3 files changed, 95 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ab042a5 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,67 @@ +# Changelog + +This file tries to follow roughly [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). +maddy uses [semver versioning](https://semver.org/). + +## Badges + +* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23090) for any bug fixes. +* ![**SECURITY**](https://img.shields.io/badge/-SECURITY-%23c00) in case of vulnerabilities. +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) for new features. +* ![**CHANGED**](https://img.shields.io/badge/-CHANGED-%23e90) for changes in existing functionality. +* ![**DEPRECATED**](https://img.shields.io/badge/-DEPRECATED-%23666) for soon-to-be removed features. +* ![**REMOVED**](https://img.shields.io/badge/-REMOVED-%23900) for now removed features. + +## Upcoming + +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Added Changelog +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Added contribution guideline +* ? + +## version 1.1.2 2020-10-04 + +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) `*`, `+` and `-` are equivalent for making unordered bullet list +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) Parsing support for fully numeric ordered lists +* ![**CHANGED**](https://img.shields.io/badge/-CHANGED-%23e90) make `Parser::Parse` accept istreams instead of stringstream +* ![**CHANGED**](https://img.shields.io/badge/-CHANGED-%23e90) CMake is creating an interface library which you can include in your own `target_link_libraries` and the global include path is untouched from maddy. + +## version 1.1.1 2019-12-27 + +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) BreakLineParser +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) HTMLParser +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) Added optional config with the following options: + * en-/disable the emphasized parser + * wrap/not wrap HTML in markdown within a paragraph in output +* ![**CHANGED**](https://img.shields.io/badge/-CHANGED-%23e90) Updated gtest to release-1.10.0 to fix build issues + + +## version 1.1.0 2019-02-19 + +* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23900) Added missing includes to BlockParser +* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23900) Added missing dtor to BlockParser and LineParser +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) `__test__` can also be used to get `text` +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) Added AppVeyor CI +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) Added clang for CI +* ![**CHANGED**](https://img.shields.io/badge/-CHANGED-%23e90) Single underscore `_` results in emphasized tag ``, single `*` in italic tag `` + +## version 1.0.3 2018-01-18 + +* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23900) Make sure that all parsers are finished +* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23900) ol documentation +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) Added Travic-CI with gcc +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) Added Howto for running the tests on the README + +## version 1.0.2 2017-12-26 + +* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23900) Fixed inline code for directly following letters (bold, emphasized and strikethrough) + +## version 1.0.1 2017-12-25 + +* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23900) Fixed inline code for bold, emphasized and strikethrough +* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23900) Fixed spelling in README +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) Use Gold Linker on Unix if available for faster compile time +* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23090) Added Github ISSUE_TEMPLATE + +## version 1.0.0 2017-12-25 + +initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..038b60f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contribution Guideline + +First of all: I am thankful for any contribution this project gets. + +## Creating Issues + +You found a bug, you miss some feature in the project or have an idea how to +improve the code? Then [create a GitHub issue](https://github.com/progsource/maddy/issues/new). + +## Creating Pull-Requests + +* Use a branch other than master. +* Add yourself to the `AUTHORS` file. +* Try to stick with the code style the files are having right now. +* Write in your commit messages what/why you did something. Often times a one-liner might be enough, but if you want to write more, make an empty line in between like: + ``` + Short description + + More and longer text for the commit message with some more information. + That can go over multiple lines. + ``` + Do not include Github issue ticket numbers inside commit messages. +* Explain for what your PR is for - like providing a use-case or something similar. +* Update documentation of the Markdown syntax if anything changed there. (`docs/definitions.md`) +* Add a changelog entry at "Upcoming" inside of `CHANGELOG.md` +* Make sure, that the tests are successful. diff --git a/README.md b/README.md index 6006b7f..671a9d6 100644 --- a/README.md +++ b/README.md @@ -78,3 +78,5 @@ There are different possibilities: * [Create a GitHub issue](https://github.com/progsource/maddy/issues/new) * Create a pull request with an own branch (don't forget to put yourself in the AUTHORS file) + +Please also read [CONTIBUTING.md](CONTIBUTING.md).