mirror of
https://github.com/quitesimpleorg/qsmaddy.git
synced 2024-12-18 09:42:37 +01:00
Added CHANGELOG and CONTRIBUTING
This commit is contained in:
Petra Baranski
parent
38f802de09
commit
6b632abd44
67
CHANGELOG.md
Normal file
67
CHANGELOG.md
Normal file
@ -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
|
||||
|
||||
*  for any bug fixes.
|
||||
*  in case of vulnerabilities.
|
||||
*  for new features.
|
||||
*  for changes in existing functionality.
|
||||
*  for soon-to-be removed features.
|
||||
*  for now removed features.
|
||||
|
||||
## Upcoming
|
||||
|
||||
*  Added Changelog
|
||||
*  Added contribution guideline
|
||||
* ?
|
||||
|
||||
## version 1.1.2 2020-10-04
|
||||
|
||||
*  `*`, `+` and `-` are equivalent for making unordered bullet list
|
||||
*  Parsing support for fully numeric ordered lists
|
||||
*  make `Parser::Parse` accept istreams instead of stringstream
|
||||
*  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
|
||||
|
||||
*  BreakLineParser
|
||||
*  HTMLParser
|
||||
*  Added optional config with the following options:
|
||||
* en-/disable the emphasized parser
|
||||
* wrap/not wrap HTML in markdown within a paragraph in output
|
||||
*  Updated gtest to release-1.10.0 to fix build issues
|
||||
|
||||
|
||||
## version 1.1.0 2019-02-19
|
||||
|
||||
*  Added missing includes to BlockParser
|
||||
*  Added missing dtor to BlockParser and LineParser
|
||||
*  `__test__` can also be used to get `<strong>text</strong>`
|
||||
*  Added AppVeyor CI
|
||||
*  Added clang for CI
|
||||
*  Single underscore `_` results in emphasized tag `<em>`, single `*` in italic tag `<i>`
|
||||
|
||||
## version 1.0.3 2018-01-18
|
||||
|
||||
*  Make sure that all parsers are finished
|
||||
*  ol documentation
|
||||
*  Added Travic-CI with gcc
|
||||
*  Added Howto for running the tests on the README
|
||||
|
||||
## version 1.0.2 2017-12-26
|
||||
|
||||
*  Fixed inline code for directly following letters (bold, emphasized and strikethrough)
|
||||
|
||||
## version 1.0.1 2017-12-25
|
||||
|
||||
*  Fixed inline code for bold, emphasized and strikethrough
|
||||
*  Fixed spelling in README
|
||||
*  Use Gold Linker on Unix if available for faster compile time
|
||||
*  Added Github ISSUE_TEMPLATE
|
||||
|
||||
## version 1.0.0 2017-12-25
|
||||
|
||||
initial release
|
||||
26
CONTRIBUTING.md
Normal file
26
CONTRIBUTING.md
Normal file
@ -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.
|
||||
Loading…
Reference in New Issue
Block a user