Skip to content

Commit

Permalink
doc: fixed doc typos, added CONTRIBUTING.md, added github templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ben-page committed Jun 9, 2016
1 parent b56b19b commit e1f2e62
Show file tree
Hide file tree
Showing 4 changed files with 189 additions and 1 deletion.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!-- Provide a clear and descriptive title in the above Title box -->

## Expected Behavior
<!-- If you're describing a bug, tell us what should happen. -->
<!-- If you're suggesting a feature request, tell us how it should work. -->

## Current Behavior
<!-- If describing a bug, tell us what happens instead of the expected behavior. -->
<!-- If suggesting a feature request, explain the difference from current behavior. -->

## Steps to Reproduce (for bugs)
<!-- Provide the exact steps, all information, and code needed to reproduce this bug. -->
<!-- Try to isolate the issue as much as possible, reducing unrelated code to get to the -->
<!-- minimal amount of code it reproduce the bug. -->
1.
2.
3.
4.

## Reason For Request (for feature requests)
<!-- Be as descriptive as possible. Take the time to explain the specific problem you are -->
<!-- facing and this would solve it -->
<!-- Provide a specific, real-world example of how and when this feature would be used. -->

## Possible Solution
<!-- Not obligatory. -->
<!-- If you can, suggest a fix, or ideas on how to implement the feature request. -->

## Background Details
<!-- How has this issue affected you? What are you trying to accomplish? -->

## Environment
<!-- Include as many relevant details about the environment you experienced the bug in -->
* Node.js Version:
* Windows/Mac/Linux:
34 changes: 34 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!-- Provide a general summary of your changes in the Title above -->

## Description
<!-- Describe your changes in detail -->

## Related Issue
<!-- This project only accepts pull requests related to open issues. -->
<!-- If suggesting a new feature or change, please discuss it in an issue first. -->
<!-- If fixing a bug, there should be an issue describing it with steps to reproduce. -->
<!-- Please link to the issue here: -->

## Motivation and Context
<!-- Why is this change required? What problem does it solve? -->

## How Has This Been Tested?
<!-- Please describe in detail how you tested your changes. -->
<!-- Include details of your testing environment, and the tests you ran to -->
<!-- see how your change affects other areas of the code, etc. -->

## Types of changes
<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] 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:
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] 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.
116 changes: 116 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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** &mdash; check if the issue has already been
reported.

2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
latest `master` or development branch in the repository.

3. **Isolate the problem** &mdash; 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&mdash;patches, improvements, new features&mdash;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/<your-username>/tedious-connection-pool
# Navigate to the newly cloned directory
cd <repo-name>
# 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 <topic-branch-name>
```

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 <topic-branch-name>
```

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.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.

Expand Down

0 comments on commit e1f2e62

Please sign in to comment.