Contribution Guidelines¶
Whether reporting bugs, discussing improvements and new ideas or writingextensions: Contributions to TinyDB are welcome! Here’s how to get started:
- Check for open issues or open a fresh issue to start a discussion arounda feature idea or a bug
- Forkthe repository on Github,create a new branch off themaster branch and start making your changes(known asGitHub Flow)
- Write a test which shows that the bug was fixed or that the feature worksas expected
- Send a pull request and bug the maintainer until it gets merged andpublished :)
Philosophy of TinyDB¶
TinyDB aims to be simple and fun to use. Therefore two key values are simplicityand elegance of interfaces and code. These values will contradict each otherfrom time to time. In these cases , try using as little magic as possible.In any case don’t forget documenting code that isn’t clear at first glance.
Code Conventions¶
In general the TinyDB source should always followPEP 8.Exceptions are allowed in well justified and documented cases. However we makea small exception concerning docstrings:
When using multiline docstrings, keep the opening and closing triple quoteson their own lines and add an empty line after it.
defsome_function():""" Documentation ... """# implementation ...
Version Numbers¶
TinyDB follows theSemVer versioning guidelines.This implies that backwards incompatible changes in the API will incrementthe major version. So think twice before making such changes.
