Contributing

If you can't help with the development (you're busy, whatever...), make sure to star this repository, as that helps other developers find LedgerMan:

You can also join our discord!

Contributing Code

If you want to contribute code, make sure you keep the class structure the same. Generally:

# --- STATIC VARIABLES --- #
# --- STATIC METHODS --- #
# --- DATA MODEL METHODS --- #
# --- CLASS SPECIFIC METHODS --- #
# --- DATA MODEL OPERATIONS --- #
  • Fork this repository:

  • Set up the environment:

    Run pip install -e . in LedgerMan's src/ for a development installation.

  • Change, fix or implement something.

    Tests: Make sure to always run nosetests (in the projects src/ directory) before commiting. We also use the black codeformatter (pip install black) - run black .

  • Submit a pull request.

    They'll likely be merged and you'll definitely get some feedback.

Other ways to help

You can also contact Finn or sponsor this project ❤️!

License

MIT License. Copyright 2020 Finn M Glas.