docs/guides/PULL_REQUESTS.md
Before you submit your pull request consider the following guidelines:
Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
Please sign our Contributor License Agreement (CLA) before sending pull requests. We cannot accept code without this.
Make your changes in a new git branch:
git checkout -b wip/my-fix-branch master
Follow our Coding Rules.
Include appropriate test cases.
Create your patch.
Run the full AngularJS Material test suite, as described in the developer documentation, and ensure that all tests pass.
Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to the commit message conventions is required because release notes are automatically generated from these messages.
git commit -a
Note: the optional commit -a command line option will automatically "add" and "rm" edited files.
Build your changes locally to ensure all the tests pass:
npm run test:full
Push your branch to GitHub:
git push origin wip/my-fix-branch
In GitHub, send a pull request to angular:master.
If we suggest changes then:
Make the required updates.
Re-run the AngularJS Material test suite to ensure tests are still passing.
Commit your new changes by ammending your original commit to squash your commits, then force push to your GitHub repository (this will update your Pull Request):
git commit -a --amend
git push --force origin wip/my-fix-branch
That's it... thank you for your contribution!
<hr/>After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
Delete the remote branch on GitHub either through a Git UI/IDE or your local shell as follows:
git push origin --delete wip/my-fix-branch
Check out the master branch:
git checkout master -f
Delete the local branch:
git branch -D wip/my-fix-branch
Update your master with the latest upstream version:
git pull --ff upstream master