Did you know ... | Search Documentation: |
![]() | Pack logicmoo_workspace -- node_modules/typeahead.js/CONTRIBUTING.md |
These contributing guidelines were proudly stolen from the Flight project
Looking to contribute something to typeahead.js? Here's how you can help.
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:
master
or integration branch in the repository.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.
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.) and any other requirements (such as test coverage).
Please follow this process; it's the best way to get your work included in the project:
# Clone your fork of the repo into the current directory git clone https://github.com/<your-username>/typeahead.js # 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/twitter/typeahead.js
git checkout master git pull upstream master
npm install bower install git checkout -b <topic-branch-name>
git pull [--rebase] upstream master
git push origin <topic-branch-name>
By contributing your code,
You agree to license your contribution under the terms of the MIT License https://github.com/twitter/typeahead.js/blob/master/LICENSE