diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..6fc84c83 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,10 @@ +root = true + +[*.{pl,pm,t,PL}] +max_line_length = off +end_of_line = lf +indent_style = space +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +indent_size = 4 diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..23d9c33e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,35 @@ +# Issue Template + +### Description + +_If you raise an issue on bug/issue please provide the requested information, if not, please just provide a description of you issue._ + +# Bugs and Issues + +### Specify what version was used + +_Please provide some information on what version of the component used._ + +``` +$ perl -I lib -MWorkflow -e 'print "$Workflow::VERSION\n"' +``` + +### Supply some information on the environment + +_Please provide some information on your **Perl** interpreter._ + +``` +$ perl -V +``` + +### Expected behaviour + +_What behaviour did you expect?_ + +### Actual and observed behaviour + +_What behaviour did you observe?_ + +### Steps to reproduce the behaviour + +A test, script or one-liner is preferred, but anything that can help is good diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..2ab0ceeb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +# Description + +Please include a summary of the proposed improvement or addressed issue. + +Fixes/addresses (If applicable) # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# Checklist: + +- [ ] My code follows the style guidelines of this project, please see the [contribution guidelines](https://github.com/jonasbn/perl-workflow/blob/master/CONTRIBUTING.md). +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules + +You might think, that this is one crazy checklist, but it is just as much written for the maintainer of the involved software :-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..67097160 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at jonasbn@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d3998a46 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing + +These are the guidelines for contributing to this repository. + +## Issues + +File an issue if you think you've found a [bug](https://en.wikipedia.org/wiki/Software_bug). Please describe the following: + +1. What version of the involved component was used +2. What environment was the component used in (OS, Perl version etc.) +3. What was expected +4. What actually occurred +5. What had to be done to reproduce the issue + +Please use the [issue template](https://github.com/jonasbn/perl-workflow/blob/master/.github/ISSUE_TEMPLATE.md). + +## Patches + +Patches for fixes, features, and improvements are accepted via pull requests. + +Pull requests should be based on the **master** branch, unless you want to contribute to an active branch for a specific topic. + +Please use the [PR template](https://github.com/jonasbn/perl-workflow/blob/master/.github/PULL_REQUEST_TEMPLATE.md). + +Coding guidelines are basic, please use: + +- [EditorConfig](http://editorconfig.org/) (configuration included in repository as `.editorconfig`) +- [PerlTidy](http://perltidy.sourceforge.net/) (configuration included in repository as `.perlcriticrc`) + +For other coding conventions please see the Perl::Critic configuration in: `t/perlcriticrc`. + +And if you are really adventurous, you are most welcome to read [my general coding conventions](https://gist.github.com/jonasbn/c2f703c68340384cfc61bb9c38adb2ff) (WIP). + +Do note that the repository uses [propot](https://probot.github.io/), so if you write comments in formatted as: + +```perl +# @todo You have an in issue in your heading +# @body But a descriptive body +``` + +The [`TODO bot`](https://probot.github.io/apps/todo/) will the create a GitHub issue automatically upon `push` to the repository. + +All contributions are welcome and most will be accepted. + +## Licensing and Copyright + +Please note that accepted contributions are included in the repository and hence under the same license as the repository contributed to.