mirror of
https://github.com/progsource/maddy.git
synced 2026-03-25 16:00:39 +01:00
2a00c9fb0b
* Add regex for title text version of links Original parser matched: [name](http:://link) Add match for: [name](http:://link "title text") * Add tests and improve regex's * Several new tests in test_maddy_linkparser.cpp (Some with paths for future improvement, and one to ensure an overzealous future update doesn't disallow actually-used special characters like o-umlaut). * URLs now ignore leading/trailing spaces. * URLs now don't match on internal spaces or quotes. * Small grammar fix in CONTRIBUTING.md * Updated changelog.
20 lines
907 B
Markdown
20 lines
907 B
Markdown
# 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.
|
|
* Feel free to add yourself to the `AUTHORS` file. (optional)
|
|
* Use clang-format to format the code.
|
|
* Write in your commit messages what/why you did something. Often times a one-liner might be enough.
|
|
* 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 and if you wrote a bugfix, to have a test that highlights the issue.
|