diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2014-06-16 08:12:08 -0400 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2014-06-16 08:12:08 -0400 |
| commit | 9e7522ee611796e568aa58dc0bc878ac8a1c471c (patch) | |
| tree | 1dc975240705ccd36b7111a8888f634c7a2e5042 | |
| parent | 68dd639c91b8ff263f53bd303a766f30399820d7 (diff) | |
| download | external_python_setuptools-9e7522ee611796e568aa58dc0bc878ac8a1c471c.tar.gz external_python_setuptools-9e7522ee611796e568aa58dc0bc878ac8a1c471c.tar.bz2 external_python_setuptools-9e7522ee611796e568aa58dc0bc878ac8a1c471c.zip | |
Started work on a developer guide.
| -rw-r--r-- | docs/developer-guide.txt | 41 | ||||
| -rw-r--r-- | docs/development.txt | 1 |
2 files changed, 42 insertions, 0 deletions
diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt new file mode 100644 index 00000000..fbee5e67 --- /dev/null +++ b/docs/developer-guide.txt @@ -0,0 +1,41 @@ +================================ +Developer's Guide for Setuptools +================================ + +If you want to know more about contributing on Setuptools, this is the place. + + +.. contents:: **Table of Contents** + + +---------------------- +Repository and Tracker +---------------------- + +... + +.. git mirror + +----------------- +Authoring Tickets +----------------- + +... + +------------------------ +Submitting Pull Requests +------------------------ + +Use Mercurial bookmarks or Git branches. Use incremental commits. Minimize +stylistic changes. + +------------------- +Semantic Versioning +------------------- + +Setuptools follows ``semver`` with some exceptions: + +- Uses two-segment version when three segment version ends in zero +- Omits 'v' prefix for tags. + +.. explain value of reflecting meaning in versions. diff --git a/docs/development.txt b/docs/development.txt index ba927c73..e35ba39b 100644 --- a/docs/development.txt +++ b/docs/development.txt @@ -30,6 +30,7 @@ setuptools changes. You have been warned. .. toctree:: :maxdepth: 1 + .. developer-guide formats releases |