1# Contributing
2
3These are the guidelines for contributing to this repository.
4
5## Issues
6
7File an issue if you think you've found a [bug](https://en.wikipedia.org/wiki/Software_bug). Please describe the following:
8
91. What version of the involved component was used
102. What environment was the component used in (OS, Perl version etc.)
113. What was expected
124. What actually occurred
135. What had to be done to reproduce the issue
14
15Please use the [issue template](.github/ISSUE_TEMPLATE.md).
16
17## Patches
18
19Patches for fixes, features, and improvements are accepted via pull requests.
20
21Pull requests should be based on the **master** branch, unless you want to contribute to an active branch for a specific topic.
22
23Please use the [PR template](.github/PULL_REQUEST_TEMPLATE.md).
24
25Coding guidelines are basic, please use:
26
27- [EditorConfig](http://editorconfig.org/) configuration included in repository as `.editorconfig`
28- [PerlTidy](http://perltidy.sourceforge.net/) configuration included in repository as `.perlcriticrc`
29
30For other coding conventions please see the Perl::Critic configuration in: `t/perlcriticrc`.
31
32And if you are really adventurous, you are most welcome to read [my general coding conventions](https://gist.github.com/jonasbn/c2f703c68340384cfc61bb9c38adb2ff) (WIP).
33
34Do note that the repository uses [propot](https://probot.github.io/), so if you write comments formatted as:
35
36```perl
37# @todo You have an in issue in your heading
38# @body But a descriptive body
39```
40
41The [`TODO bot`](https://probot.github.io/apps/todo/) will the create a GitHub issue automatically upon `push` to the repository.
42
43All contributions are welcome and most will be accepted.
44
45## Licensing and Copyright
46
47Please note that accepted contributions are included in the repository and hence under the same license as the repository contributed to.
48