mirror of
https://github.com/zhigang1992/typeahead.js.git
synced 2026-01-12 22:53:14 +08:00
1.3 KiB
1.3 KiB
Contributing Guidelines
Setup
- Fork the project and clone the fork to your machine.
- Create a feature branch to work in.
$ git checkout -b name-of-feature
Writing Code
- Use the project's coding style, not your own. If the code you write looks drastically different than the preexisting code, you're doing it wrong.
- Include tests that fail without your code, and pass with it.
- Commits should have meaningful messages. If you end up with a bunch of commits with garbage messages, squash your commits before submitting a pull request.
Pull Requests
- Push your feature branch to your remote repo on GitHub.
$ git push origin name-of-feature - Create a pull request against master.
- Write a meaningful title and description. If you've added a new feature or break backwards compatibility, let us know so we can updated the docs accordingly.
- Submit the pull request!
License
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