diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..80268f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,35 @@ + + +## Expected Behavior + + + +## Current Behavior + + + +## Steps to Reproduce (for bugs) + + + +1. +2. +3. +4. + +## Reason For Request (for feature requests) + + + + +## Possible Solution + + + +## Background Details + + +## Environment + +* Node.js Version: +* Windows/Mac/Linux: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..7000786 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ + + +## Description + + +## Related Issue + + + + + +## Motivation and Context + + +## How Has This Been Tested? + + + + +## Types of changes + +- [ ] 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 change) + +## Checklist: + + +- [ ] My code follows the code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. +- [ ] I have read the **CONTRIBUTING** document. +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1814a34 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,116 @@ +# Contributing to tedious-connection-pool + +Looking to contribute something to tedious-connection-pool? Here's how you can help. + + +## Bugs reports + +A bug is a _demonstrable problem_ that is caused by the code in the +repository. Good bug reports are extremely helpful – thank you! + +Guidelines for bug reports: + +1. **Use the GitHub issue search** — check if the issue has already been + reported. + +2. **Check if the issue has been fixed** — try to reproduce it using the + latest `master` or development branch in the repository. + +3. **Isolate the problem** — ideally create a reduced test + case and a live example. + +4. Please try to be as detailed as possible in your report. Include specific + information about the environment – operating system and version, browser + and version, version of tedious-connection-pool – and steps required to reproduce + the issue. + + +## Feature requests & contribution enquiries + +Feature requests are welcome. But take a moment to find out whether your idea +fits with the scope and aims of the project. It's up to *you* to make a strong +case for the inclusion of your feature. Please provide as much detail and +context as possible. + +Contribution enquiries should take place before any significant pull request, +otherwise you risk spending a lot of time working on something that we might +have good reasons for rejecting. + + +## Pull requests + +Good pull requests—patches, improvements, new features—are a fantastic +help. They should remain focused in scope and avoid containing unrelated +commits. + +Make sure to adhere to the coding conventions used throughout the codebase +(indentation, accurate comments, etc.). Please run `npm test` before you push: +this will run the mocha unit tests (using karma runner). + +Please follow this process; it's the best way to get your work included in the +project: + +1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, + and configure the remotes: + + ```bash + # Clone your fork of the repo into the current directory + git clone https://github.com//tedious-connection-pool + # Navigate to the newly cloned directory + cd + # Assign the original repo to a remote called "upstream" + git remote add upstream git://github.com/pekim/tedious-connection-pool + ``` + +2. If you cloned a while ago, get the latest changes from upstream: + + ```bash + git checkout master + git pull upstream master + ``` + +3. Install the dependencies and create a new topic branch (off the master + branch) to contain your feature, change, or fix: + + ```bash + npm install + git checkout -b + ``` + +4. Make sure to update, or add to the tests when appropriate. Patches and + features will not be accepted without tests. Run `make test` to check that + all tests pass after you've made changes. + +5. Commit your changes in logical chunks. Provide clear and explanatory commit + messages. Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) + feature to tidy up your commits before making them public. + +6. Locally merge (or rebase) the upstream development branch into your topic branch: + + ```bash + git pull [--rebase] upstream master + ``` + +7. Push your topic branch up to your fork: + + ```bash + git push origin + ``` + +8. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) + with a clear title and description. + +9. If you are asked to amend your changes before they can be merged in, please + use `git commit --amend` (or rebasing for multi-commit Pull Requests) and + force push to your remote feature branch. You may also be asked to squash + commits. + +## License + +By contributing your code, + +You agree to license your contribution under the terms of the MIT License +https://opensource.org/licenses/MIT + +## Notes +Thanks to the [tedious-connection-pool](https://github.com/tedious-connection-pooljs/tedious-connection-pool) project for this excellent CONTRIBUTING.md file. \ No newline at end of file diff --git a/README.md b/README.md index 0caf70d..745dfac 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ Close all pooled connections and stop making new ones. The pool should be discar * `callback()` {Function} Callback function ### connectionPool.error {event} -The 'error' event is emitted when a connection fails to connect to the SQL Server. The pool simply will retries indefinitely. The application may want to handle errors in a more nuanced way. +The 'error' event is emitted when a connection fails to connect to the SQL Server. The pool will simply retry indefinitely. The application may want to handle errors in a more nuanced way. ## Class: Connection The following method is added to the Tedious [Connection](http://pekim.github.com/tedious/api-connection.html) object. @@ -106,6 +106,9 @@ Release the connect back to the pool to be used again ## Changelog +### Version 1.0.2 +* Added additional log message when acquiring a connection. + ### Version 1.0.0 * No changes from v0.3.9.