About

Contributing

Thanks for contributing! Feel free to open an issue for any bugs, typos, unhelpful docs, or general unhappiness which you may encounter while using Bloop. If you want to create a pull request, even more awesome! Please make sure all the non-integ tox environments pass.

To start developing Bloop first create a fork, then clone and run the tests:

git clone git@github.com:[YOU]/bloop.git
cd bloop
pip install tox -e .
tox -e unit, docs

Versioning

Public API

Bloop follows Semantic Versioning 2.0.0 and a draft appendix for its Public API.

The following are enforced:

  • Backwards incompatible changes in major version only
  • New features in minor version or higher
  • Backwards compatible bug fixes in patch version or higher (see appendix)

Internal API

The Internal API is not versioned, and may make backwards incompatible changes at any time. When a class or function is not explicitly documented as part on the public or internal api, it is part of the internal api. Still, please open an issue so it can be appropriately documented.

License

The MIT License (MIT)

Copyright (c) 2016 Joe Cross

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.