Skip to content
This repository has been archived by the owner on Jan 10, 2018. It is now read-only.

Commit

Permalink
Merge pull request #216 from stripe/jenan-github-templates
Browse files Browse the repository at this point in the history
Add contributing docs, add issue and PR templates, and update README.
  • Loading branch information
jenanwise committed Apr 18, 2016
2 parents 42f862f + eb95124 commit 26eb48c
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 1 deletion.
16 changes: 16 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Thanks for your interest in contributing!

## Filing issues

`jQuery.payment` is not currently accepting feature requests. We _are_ interested in fixing bugs and updating credit card BINs where appropriate. Please file issues for these items only.

When filing bugs, make sure to follow the issue template. When reporting credit card BIN changes, please include links to supporting documentation.

## Submitting pull requests

We will happily review and merge pull requests for bugs and card number changes. When submitting a pull request:

- Ensure that the code and commit message are well-commented and grammatically correct.
- Follow the style of the rest of the code, where possible.
- Make sure that your diff is the minimal set of changes necessary to fix the bug in question.
- Follow the pull request template.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Expected behavior

Describe the expected behavior. For new credit card BIN numbers, please include supporting references.

## Actual behavior

Describe the actual behavior. List all browsers affected, as specifically as possible (e.g. "Chrome 49.2623.112 on OS X 10.11.4", not just "Chrome").

## Steps to reproduce

Describe steps to reproduce the problem. Please include a link to a minimal reproduction of the problem with jsfiddle (or similar tool) where possible.
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Summary

Simple summary of what was changed.

## Motivation

Why are you making this change? Please provide supporting references for new BIN numbers and links to minimal reproductions (e.g. with jsfiddle) when fixing bugs.

## Testing

How was the code tested? Be as specific as possible.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,17 @@

A general purpose library for building credit card forms, validating inputs and formatting numbers.

For example, you can make an input act like a credit card field (with number formatting and length restriction):
## Project status

We consider `jQuery.payment` to be feature complete. We continue to use it in production, and we will happily accept bug reports and pull requests fixing those bugs, but we will not be adding new features or modifying the project for new frameworks or build systems.

### Why?

The library was born in a different age, and we think it has served tremendously, but it is fundamentally doing too many things. Complecting DOM element manipulation, input masking, card formatting, and cursor positioning makes it difficult to test and modify. An ideal version of this library would separate the independent components and make the internal logic functional.

## Usage

You can make an input act like a credit card field (with number formatting and length restriction):

``` javascript
$('input.cc-num').payment('formatCardNumber');
Expand Down

0 comments on commit 26eb48c

Please sign in to comment.