summaryrefslogtreecommitdiffstats
path: root/scripts/external_libs/dpkt-1.8.6.2/docs/contributing.rst
diff options
context:
space:
mode:
authorDan Klein <danklei@cisco.com>2015-08-27 10:58:01 +0300
committerDan Klein <danklei@cisco.com>2015-08-27 10:58:01 +0300
commitc2154c0d362ced8f8b5181799c369e1497c958e1 (patch)
tree981b975d6f5c1ea860e462b66adab3f3bbc81360 /scripts/external_libs/dpkt-1.8.6.2/docs/contributing.rst
parentf8ac9d14a989c8cf1535e16165551dfa370b0b74 (diff)
reverting to dpkt v1.8.6 instead of 1.8.6.2 to avoid importing error of pystone modue
Diffstat (limited to 'scripts/external_libs/dpkt-1.8.6.2/docs/contributing.rst')
-rw-r--r--scripts/external_libs/dpkt-1.8.6.2/docs/contributing.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/scripts/external_libs/dpkt-1.8.6.2/docs/contributing.rst b/scripts/external_libs/dpkt-1.8.6.2/docs/contributing.rst
new file mode 100644
index 00000000..cae4acfe
--- /dev/null
+++ b/scripts/external_libs/dpkt-1.8.6.2/docs/contributing.rst
@@ -0,0 +1,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)
+