@@ -23,3 +23,57 @@ It also has various callbacks for the buttons, opening closing the notifications
2323### Documentation
2424
2525Documentation and examples are here: < http://needim.github.io/noty >
26+
27+ ***
28+
29+ ### Pull Requests
30+
31+ 1 . [ Fork] ( http://help.github.com/fork-a-repo/ ) the project, clone your fork,
32+ and configure the remotes:
33+
34+ ``` bash
35+ # Clone your fork of the repo into the current directory
36+ git clone https://github.com/< your-username> /noty.git
37+ # Navigate to the newly cloned directory
38+ cd noty
39+ # Assign the original repo to a remote called "upstream"
40+ git remote add upstream https://github.com/needim/noty.git
41+ ```
42+
43+ 2 . If you cloned a while ago, get the latest changes from upstream:
44+
45+ ``` bash
46+ git checkout develop
47+ git pull upstream develop
48+ ```
49+
50+ 3 . Create a new topic branch (off the main project development branch) to
51+ contain your feature, change, or fix:
52+
53+ ``` bash
54+ git checkout -b < topic-branch-name>
55+ ```
56+
57+ 4 . Commit your changes in logical chunks. Please adhere to these [ git commit
58+ message guidelines] ( http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html )
59+ or your code is unlikely be merged into the main project. Use Git's
60+ [ interactive rebase] ( https://help.github.com/articles/interactive-rebase )
61+ feature to tidy up your commits before making them public.
62+
63+ 5 . Locally merge (or rebase) the upstream development branch into your topic branch:
64+
65+ ``` bash
66+ git pull [--rebase] upstream develop
67+ ```
68+
69+ 6 . Push your topic branch up to your fork:
70+
71+ ``` bash
72+ git push origin < topic-branch-name>
73+ ```
74+
75+ 7 . [ Open a Pull Request] ( https://help.github.com/articles/using-pull-requests/ )
76+ with a clear title and description against the ` develop ` branch.
77+
78+ ** IMPORTANT** : By submitting a patch, you agree to allow the project owners to
79+ license your work under the the terms of the [ MIT License] ( LICENSE.txt ) .
0 commit comments