[Python-modules-commits] [python-pyld] 205/276: Add HACKING doc.

[Wolfgang Borgert]

This is an automated email from the git hooks/post-receive script.

debacle pushed a commit to branch master
in repository python-pyld.

commit e1186f1af80a17f9300a35fc2ea7f7a8f4623b3d
Author: David I. Lehn <dlehn at digitalbazaar.com>
Date:   Wed Sep 25 14:45:00 2013 -0400

    Add HACKING doc.
---
 HACKING.rst | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/HACKING.rst b/HACKING.rst
new file mode 100644
index 0000000..774a3b2
--- /dev/null
+++ b/HACKING.rst
@@ -0,0 +1,39 @@
+Hacking on payswarm.js
+======================
+
+Want to hack on payswarm.js? Great! Here are a few notes:
+
+Code
+----
+
+* In general, follow the common [PEP 8 Style Guide][].
+* Try to make the code pass [flake8][] checks.
+  * `flake8 lib/pyld/jsonld.py`
+* Use version X.Y.Z-dev in dev mode.
+* Use version X.Y.Z for releases.
+
+Versioning
+----------
+
+* Follow the [Semantic Versioning][] guidelines.
+
+Release Process
+---------------
+
+* commit changes
+* `$EDITOR lib/pyld/jsonld.py`: update to release version and remove `-dev`
+  suffix.
+* `git commit lib/pyld/jsonld.py -m "Release {version}."`
+* `git tag {version}`
+* `$EDITOR lib/pyld/jsonld.py`: update to next version and add `-dev` suffix.
+* `git commit lib/pyld/jsonld.py -m "Start {next-version}."`
+* `git push --tags`
+
+To ensure a clean upload, use a clean checkout, and run the following:
+
+* `git checkout {version}`
+* `python setup.py sdist upload`
+
+[PEP 8 Style Guide]: http://www.python.org/dev/peps/pep-0008/
+[flake8]: https://pypi.python.org/pypi/flake8
+[Semantic Versioning]: http://semver.org/

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-pyld.git