docs: Add CONTRIBUTING.md and Contributor Covenant CoC (#46)#77
Merged
Conversation
CONTRIBUTING.md covers prerequisites, dev setup, tests, flake8 linting, PR conventions, a broker-plugin walkthrough, and a tax-correctness bug reporting flow. Bilingual-friendly wording so PL/EN contributors are both at home. README.md / README.pl.md now surface a Contributing section that links to the new guide and to CODE_OF_CONDUCT.md (Contributor Covenant v2.1, maintainer contact filled in). Also ignores .coverage / htmlcov / .pytest_cache — the contributing guide teaches pytest --cov, so these artifacts will start appearing in working trees.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CONTRIBUTING.mdcovering prerequisites, dev setup, tests, flake8 linting, PR conventions, a broker-plugin walkthrough, and tax-correctness bug reporting. Bilingual-friendly tone (PL/EN welcome).CODE_OF_CONDUCT.md— Contributor Covenant v2.1, canonical text with the maintainer contact filled in.README.md/README.pl.mdgain a Contributing / Współtworzenie section pointing at both files. Replaces the previous bare-bones## Developmentblock that duplicated the quickstart..gitignorepicks up.coverage,htmlcov/, and.pytest_cache/since the guide teachespytest --cov.Closes #46.
Notes for reviewer
pre-commit run --all-files". Consolidate operation and transaction reading from csv #9 is still open and there's nopre-commitconfig yet, so the guide documents the current flake8 direct invocation. A follow-up edit lands naturally when Consolidate operation and transaction reading from csv #9 ships.docs/DEVELOPING_PLUGINS.md, but that file was never created (the referenced issue number turned out to be unrelated). The guide instead inlines the short recipe and cross-links to the existingpit38/plugins/README.md.CODE_OF_CONDUCT.mdlistsprzemyslawb@monday.comas the reporting contact — already public in git history, but flag me if you want to swap for a GitHub Security Advisory flow only.Test plan
CONTRIBUTING.mdrenders cleanly on GitHub (TOC links work)CODE_OF_CONDUCT.md,.github/PULL_REQUEST_TEMPLATE.md,.github/ISSUE_TEMPLATE/broker_support_en.md,docs/TAX_RULES.md,pit38/plugins/README.md,pit38/data_sources/*/example_format.csvpytest tests/still green