Merge pull request #151 from splitio/task/documentationRevamp

Task/documentation revamp

Author: mmelograno

.github/pull_request_template.md

@@ -1,16 +1,7 @@
 # Python SDK
 
-## Tickets covered:
-*
-
 ## What did you accomplish?
-* Bullet 1
-* Bullet 2
 
-## How to test new changes?
-* python setup.py test to test everythin
-* pytest <SPECIFIC_FILE> to test a file in particular (requires pytest, pytest-cov & pytest-mock to be installed)
+## How do we test the changes introduced in this PR?
 
-## Extra Notes
-* Bullet 1
-* Bullet 2
+## Extra Notes

CHANGES.txt

@@ -1,11 +1,14 @@
 8.1.2 (Jul 19, 2019)
  - Validated TLS support for redis connections
  - Fixed traffic type count issue
+
 8.1.1 (14 Jun, 2019)
  - Fixed python3 compatibility issue in uwsgi caching mode.
+
 8.1.0 (3 Jun, 2019)
  - Added properties to track method.
  - Input Validation: added validation for traffic types, split names and multiple factory instantiation.
+
 8.0.0 (Apr 24, 2019)
  - Full SDK Refactor/rewrite.
  - New block until ready behaviour.
@@ -14,74 +17,101 @@
  - Impressions not flushing on destroy bugfix.
  - Removed unnecessary dependencies.
  - Test suite rewritten.
+
 7.0.1 (Mar 8, 2019)
  - Updated Splits refreshing rate.
  - Replaced exception log level to error level.
  - Improved validation for apikey.
+
 7.0.0 (Feb 21, 2019)
  - BREAKING CHANGE: Stored Impressions in Queue.
  - Fixed bug related to Machine Name and Machine IP.
  - Updated Input Validation.
  - New hash implementation supporting more platforms.
+
 6.2.2 (Dec 17, 2018)
  - Fixed issue on selecting db for Sentinel.
+
 6.2.1 (Dec 6, 2018)
  - Fixed traffic allocation issue on 1%.
  - Allowed hypens in 'localhost mode' file values.
+
 6.2.0 (Oct 5, 2018)
  - Added get_treatments method.
+
 6.1.0 (Sep 25, 2018)
  - Add custom impression listener feature.
  - Input Sanitization for track, get_treatment and split.
+
 6.0.0 (Aug 29, 2018)
  - Add support for redis sentinel
  - UWSGI performance boost (breaking change)
  - Add support for more c++ compilers in windows for mumur hash extension
+
 5.5.0 (Feb 28, 2018)
  - Add support for .track
+
 5.4.3 (Jan 7, 2018)
  - Move impressions listener to it's own thread
  - Fix bug in localhost client
  - Removed unmaintained dependency causing issues with newer mac os updates
+
 5.4.2 (Dec 22, 2017)
  - Update labels
+
 5.4.1 (Dec 11, 2017)
  - Handle destroyed client in manager
+
 5.4.0 (Sep 6, 2017)
  - Add Client-Destroy support
  - Add Impression listener support for in-memory and uwsgi modes
+
 5.3.0 (Aug 1, 2017)
  - Add off-grid support for localhost broker (auto refresh splits from file)
+
 5.2.2 (Aug 1, 2017)
  - Adding hotfix to set traffic allocation to 100 by default
+
 5.2.1 (Jul 28, 2017)
  - Adding hotfix to keep alive fetcher threads if proxy/backend connection goes temporarily down.
+
 5.2.0 (Jul 26, 2017)
  - Adding Adding regex & boolean matcher
+
 5.1.0 (Jul 19, 2017)
  - Adding dependency matcher
  - Refactoring clients into brokers
+
 5.0.0 (Jun 13, 2017)
  - BREAKING BACKWARD COMPATIBILITY
  - Adding support for Split Synchronizer service
+
 4.1.1 (May 25, 2017)
  - Python 3 fixed incompatible comparison between None an integer
+
 4.1.0 (May 16, 2017)
  - Adding support for String and Set Matchers
+
 4.0.2 (May 8, 2017)
  - Adding support for Traffic Allocation
+
 4.0.1 (April 19, 2017)
  - Hotfix Hashing enumerator to default value LEGACY
+
 4.0.0 (April 17, 2017)
  - Added support for murmur3 hashing native and cpp version for performance
-2.2.1
+
+2.2.1 (Mar 1, 2017)
  - Ignore invalid Split fetched from Redis cache
-2.2.0
+
+2.2.0 (Feb 17, 2017)
  - Added uwsgi cache support
  - Fixed HTTP status code exceptions
-2.1.0
+
+2.1.0 (Jan 19, 2017)
  - Added enabled labels
  - Added impressions by sdk and version including bucketing key
-2.0.5
+
+2.0.5 (Dec 2, 2016)
  - Added SDK Factory Method with Manager API and Sdk Client
  - Added Bucketing key support

CONTRIBUTORS-GUIDE.md

@@ -0,0 +1,31 @@
+# Contributing to the Split Python SDK
+
+Split SDK is an open source project and we welcome feedback and contribution. The information below describes how to build the project with your changes, run the tests, and send the Pull Request(PR).
+
+## Development
+
+### Development process
+
+1. Fork the repository and create a topic branch from `development` branch. Please use a descriptive name for your branch.
+2. While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like "fix bug".
+3. Make sure to add tests for both positive and negative cases.
+4. <if applicable> Run the linter script of the project and fix any issues you find.
+5. Run the build script and make sure it runs with no errors.
+6. Run all tests and make sure there are no failures.
+7. `git push` your changes to GitHub within your topic branch.
+8. Open a Pull Request(PR) from your forked repo and into the `development` branch of the original repository.
+9. When creating your PR, please fill out all the fields of the PR template, as applicable, for the project.
+10. Check for conflicts once the pull request is created to make sure your PR can be merged cleanly into `development`.
+11. Keep an eye out for any feedback or comments from Split's SDK team.
+
+### Running tests
+
+To run test you need to execute the following commands:
+1. `pip install -U pip setuptools`
+2. `python setup.py install`
+3. `pip install redis pytest pytest-cov pytest-mock`
+4. `python setup.py test`
+
+# Contact
+
+If you have any other questions or need to contact us directly in a private manner send us a note at sdks@split.io.