Skip to content

docs: add plugin development guides (EN + PL)#84

Open
qorexdevs wants to merge 1 commit into
pbialon:mainfrom
qorexdevs:test/stock-loader-coverage-58
Open

docs: add plugin development guides (EN + PL)#84
qorexdevs wants to merge 1 commit into
pbialon:mainfrom
qorexdevs:test/stock-loader-coverage-58

Conversation

@qorexdevs
Copy link
Copy Markdown
Contributor

Summary

Adds a full broker-plugin development guide in English and Polish, then links it from the main contributor docs.

Closes #55.

Changes

  • added docs/DEVELOPING_PLUGINS.md (EN)
  • added docs/DEVELOPING_PLUGINS.pl.md (PL)
  • linked both guides from README.md, CONTRIBUTING.md, and pit38/plugins/README.md
  • added an Unreleased changelog entry

Tax-correctness impact

  • No impact - purely refactor, docs, tests, CI
  • Yes, tax output changes - explain what and why, and whether existing test expectations were updated

Testing

  • pytest tests/ passes locally
  • Added tests for new behaviour (or explained why not applicable)
  • Tested on a real CSV if tax-calc change

Docs-only change, no runtime code touched.

Documentation

  • Updated TAX_RULES.md / TAX_RULES.pl.md if tax rules clarified or corrected
  • Updated CHANGELOG.md with an entry
  • Updated relevant README / plugin docs
  • Updated TAX_LAW_AUDIT.md if this closes an audit issue

Reviewer notes

Issue #55 asked for bilingual plugin docs with cookiecutter flow, examples (Revolut + Binance), tax checklist, and links from project docs. This PR implements that scope only.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Write DEVELOPING_PLUGINS.md (EN + PL)

1 participant