Skip to content

Commit d054e69

Browse files
committed
Add CONTRIBUTING.md, Contributors; fix README
1 parent c48f547 commit d054e69

File tree

5 files changed

+64
-19
lines changed

5 files changed

+64
-19
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing to Term::CLI
2+
3+
These are the guidelines for contributing to the Term::CLI repository.
4+
5+
## Issues
6+
7+
File an issue if you think you've found a bug. Please describe
8+
9+
1. How can it be reproduced
10+
2. What was expected
11+
3. What actually occurred
12+
4. What version of the involved component
13+
14+
Issues should be filed on Github:
15+
16+
* https://github.com/sbakker/perl-Term-CLI/issues
17+
18+
## Patches
19+
20+
Patches for fixes, features, and improvements are accepted via pull requests.
21+
22+
Pull requests should be based on the **master branch**, unless you want to contribute to an active branch for a specific topic.
23+
24+
* https://github.com/sbakker/perl-Term-CLI
25+
26+
All contributions are welcome!
27+
28+
## Licensing and copyright
29+
30+
Please note that accepted contributions are included in the repository and hence under the same license as the repository contributed to.

Contributors

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
The following people have helped to make Term::CLI what it is today, either
2+
by sending pull requests, patches or suggestions, or by reporting or working
3+
to fix bugs.
4+
5+
Thank-you to one and all!
6+
7+
8+
Slaven Rezić [email protected]
9+
Heince Kurniawan [email protected]

MANIFEST

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.023.
2+
CONTRIBUTING.md
23
Changes
4+
Contributors
35
INSTALL
46
LICENSE
57
MANIFEST
68
MANIFEST.SKIP
79
META.json
810
META.yml
911
Makefile.PL
10-
README
12+
README.md
1113
cpanfile
1214
examples/readline_cli.pl
1315
examples/readline_completion_demo.pl

README

Lines changed: 0 additions & 18 deletions
This file was deleted.

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Term::CLI
2+
3+
The `Term::CLI` module implements a convenient interactive CLI parser based on [Term::ReadLine](https://metacpan.org/pod/Term::ReadLine), providing command-line completion and input validation.
4+
5+
For more information, see the [Term::CLI::Tutorial](https://metacpan.org/dist/Term-CLI/view/lib/Term/CLI/Tutorial.pod) and [Term::CLI::Intro](https://metacpan.org/dist/Term-CLI/view/lib/Term/CLI/Intro.pod) POD pages.
6+
7+
## Repository Information
8+
9+
The source code is maintained at: https://github.com/sbakker/perl-Term-CLI
10+
11+
## Contributing
12+
13+
See the [CONTRIBUTING.md](CONTRIBUTING.md) file.
14+
15+
## Copyright and License
16+
17+
This software is copyright (c) 2021 by Steven Bakker (SBAKKER).
18+
19+
This is free software; you can redistribute it and/or modify it under
20+
the same terms as the Perl 5 programming language system itself.
21+
22+
For more details, see the full text of the licenses in the [LICENSE](LICENSE) file.

0 commit comments

Comments
 (0)