blob: cae4acfe92e880a0418c68c462d073028d60ba28 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
============
Contributing
============
Report a Bug or Make a Feature Request
--------------------------------------
Please go to the GitHub Issues page: https://github.com/kbandla/dpkt/issues.
Checkout the Code
-----------------
::
git clone https://github.com/kblandla/dpkt.git
Become a Developer
------------------
dpkt uses the 'GitHub Flow' model: `GitHub Flow <http://scottchacon.com/2011/08/31/github-flow.html>`_
- To work on something new, create a descriptively named branch off of master (ie: my-awesome)
- Commit to that branch locally and regularly push your work to the same named branch on the server
- When you need feedback or help, or you think the branch is ready for merging, open a pull request
- After someone else has reviewed and signed off on the feature, you can merge it into master
Getting Started
~~~~~~~~~~~~~~~
- Fork the repo on GitHub
- git clone git@github.com:your_name_here/dpkt.git
New Feature or Bug
~~~~~~~~~~~~~~~~~~
::
$ git checkout -b my-awesome
$ git push -u origin my-awesome
$ <code for a bit>; git push
$ <code for a bit>; git push
$ tox (this will run all the tests)
- Go to github and hit 'New pull request'
- Someone reviews it and says 'AOK'
- Merge the pull request (green button)
|
