Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

38 lines (28 loc) · 1.25 KB
Raw

How to contribute

Welcome to contribute! The general todo list is this:

  • discuss the idea in the chat
  • get the informal approve
  • go to Testing

Color Schemes

If you have a nice color scheme, pls proceed to contributing it, some details on how to do it are in FAQ. You can also ask in the chat.

The rest of the code

This package was written because other tools' code looked overly complex or hard to read or error-prone to use :) Therefore there are some codestyle guidelines applied:

  • code transparent for linter
  • type annotations everywhere
  • no **kwargs, *args, dicts-instead-of-objects
  • no classes other than simple dataclasses with create-like methods
  • naming that requires to remember as few things as possible
  • no overrides with if arg is None logic inside

Testing

  • add new test cases using assert_smart_equals_ref
  • create new dump files and check coverage by running PYTEST_UPDATE_REFS=1 python3 -m pytest -s --cov=./traceback_with_variables --cov-report=xml
  • create a pull request to next_version branch

TODO list

  • add ...skipped N files... lines
  • fix colab example
  • fix tests for python 3.5-3.7
  • add comparison to other tools
  • add chain args
  • move to pytest-regtest in tests