From 41c71e4750393cc1d3fd16c4a55060daff0f7005 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Mon, 7 Dec 2015 08:22:29 +0100 Subject: [PATCH] repo template --- .editorconfig | 23 +++++++++++++++++++++++ AUTHORS | 1 + BUGS | 1 + CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ README.md | 40 ++++++++++++++++++++++++++++++++++------ THANKS | 4 ++++ package.xml | 30 ++++++++++++++++-------------- 7 files changed, 118 insertions(+), 20 deletions(-) create mode 100644 .editorconfig create mode 100644 AUTHORS create mode 100644 BUGS create mode 100644 CONTRIBUTING.md create mode 100644 THANKS diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..9b444ae --- /dev/null +++ b/.editorconfig @@ -0,0 +1,23 @@ +; see http://editorconfig.org +root = true + +[*] +end_of_line = lf +insert_final_newline = true +indent_style = tab +charset = utf-8 +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false + +[*.json] +indent_style = space +indent_size = 4 + +[package.xml] +indent_style = space +indent_size = 1 + +[config.w32] +end_of_line = crlf diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..67bbd91 --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +Michael Wallner diff --git a/BUGS b/BUGS new file mode 100644 index 0000000..ebbf227 --- /dev/null +++ b/BUGS @@ -0,0 +1 @@ +Yay, no known and unresolved issues yet! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..968bd44 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of +fostering an open and welcoming community, we pledge to respect all people who +contribute through reporting issues, posting feature requests, updating +documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free +experience for everyone, regardless of level of experience, gender, gender +identity and expression, sexual orientation, disability, personal appearance, +body size, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic + addresses, without explicit permission +* Other unethical or unprofessional conduct. + +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. By adopting this Code of Conduct, project +maintainers commit themselves to fairly and consistently applying these +principles to every aspect of managing this project. Project maintainers who do +not follow or enforce the Code of Conduct may be permanently removed from the +project team. + +This code of conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by opening an issue or contacting one or more of the project maintainers. + +This Code of Conduct is adapted from the +[Contributor Covenant](http://contributor-covenant.org), version 1.2.0, +available at http://contributor-covenant.org/version/1/2/0/. diff --git a/README.md b/README.md index c00b328..db97f91 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,29 @@ This is a modern binding to the mature [libpq](http://www.postgresql.org/docs/cu * Fetching simple [multi-dimensional array maps](https://mdref.m6w6.name/pq/Result/map). * Working [Gateway implementation](https://github.com/m6w6/pq-gateway). -## Installation: +## Documentation -This extension is hosted at [PECL](http://pecl.php.net) and can be installed with [PEAR](http://pear.php.net)'s pecl command: +See the [online markdown reference](https://mdref.m6w6.name/pq). - # pecl install pq +Known issues are listed in [BUGS](./BUGS) and future ideas can be found in [TODO](./TODO). -Also, watch out for self-installing [pharext](https://github.com/m6w6/pharext) packages attached to [releases](https://github.com/m6w6/ext-pq/releases). +## Installing + +### PECL + + pecl install pq + +Watch out for [PECL replicates](https://replicator.pharext.org?pq) +and pharext packages attached to [releases](./releases). + +### Checkout + + git clone github.com:m6w6/ext-pq + cd ext-pq + /path/to/phpize + ./configure --with-php-config=/path/to/php-config + make + sudo make install ## Dependencies: @@ -32,7 +48,19 @@ It optionally depends on the following extensions: * [json](http://php.net/json) +## ChangeLog -## Documentation: +A comprehensive list of changes can be obtained from the +[PECL website](https://pecl.php.net/package-changelog.php?package=pq). -Documentation is available at https://mdref.m6w6.name/pq +## License + +ext-pq is licensed under the 2-Clause-BSD license, which can be found in +the accompanying [LICENSE](./LICENSE) file. + +## Contributing + +All forms of contribution are welcome! Please see the bundled +[CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed. + +The list of past and current contributors is maintained in [THANKS](./THANKS). diff --git a/THANKS b/THANKS new file mode 100644 index 0000000..c4735d8 --- /dev/null +++ b/THANKS @@ -0,0 +1,4 @@ +Thanks go to the following people, who have contributed to this project: + +Remi Collet +Chris Wright diff --git a/package.xml b/package.xml index bcd0453..55cc679 100644 --- a/package.xml +++ b/package.xml @@ -1,20 +1,18 @@ - - + + pq pecl.php.net PostgreSQL client library (libpq) binding Documents: https://mdref.m6w6.name/pq - + Highlights: * Nearly complete support for asynchronous usage: https://mdref.m6w6.name/pq/Connection/%3A%20Asynchronous%20Usage @@ -22,7 +20,7 @@ http://pear.php.net/dtd/package-2.0.xsd"> https://mdref.m6w6.name/pq/Types/%3A%20Overview * Fetching simple multi-dimensional array maps: https://mdref.m6w6.name/pq/Result/map - * Working Gateway implementation: + * Working Gateway implementation: https://mdref.m6w6.name/pq-gateway @@ -46,14 +44,18 @@ http://pear.php.net/dtd/package-2.0.xsd"> beta stable - BSD, revised + BSD-2-Clause + + + +