Skip to content

docs: add CONTRIBUTING.md file#816

Open
qlrd wants to merge 1 commit into
selfcustody:developfrom
qlrd:docs/contrib-guidelines
Open

docs: add CONTRIBUTING.md file#816
qlrd wants to merge 1 commit into
selfcustody:developfrom
qlrd:docs/contrib-guidelines

Conversation

@qlrd
Copy link
Copy Markdown
Member

@qlrd qlrd commented Jan 7, 2026

What is this PR for?

CONTRIBUTING.md is a important file that guides new developers through the standards built by krux team through years. This isn't a monad and could be changed at time to time.

Changes made to:

  • Code
  • Tests
  • Docs
  • CHANGELOG

Did you build the code and tested on device?

  • Yes, build and tested on

What is the purpose of this pull request?

  • Bug fix
  • New feature
  • Docs update
  • Other

@qlrd qlrd force-pushed the docs/contrib-guidelines branch from 5955e70 to ef98a0d Compare January 7, 2026 15:02
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.31%. Comparing base (8c6579a) to head (8960644).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #816   +/-   ##
========================================
  Coverage    97.31%   97.31%           
========================================
  Files           83       83           
  Lines        10632    10632           
========================================
  Hits         10346    10346           
  Misses         286      286           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@qlrd qlrd force-pushed the docs/contrib-guidelines branch 5 times, most recently from b5e9334 to 1137f7d Compare January 7, 2026 15:12
@qlrd qlrd marked this pull request as ready for review January 7, 2026 15:22
@qlrd qlrd force-pushed the docs/contrib-guidelines branch 2 times, most recently from 3cf9dd5 to 71f346a Compare January 8, 2026 23:08
Copy link
Copy Markdown
Member

@odudex odudex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a few changes

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@qlrd qlrd force-pushed the docs/contrib-guidelines branch 2 times, most recently from c9202cf to 902a07d Compare April 5, 2026 13:38
@qlrd qlrd marked this pull request as draft April 5, 2026 13:40
@qlrd qlrd force-pushed the docs/contrib-guidelines branch 5 times, most recently from 60423df to 0b07342 Compare April 5, 2026 15:01
@qlrd qlrd force-pushed the docs/contrib-guidelines branch from 0b07342 to f4a2cec Compare April 15, 2026 02:02
@qlrd qlrd marked this pull request as ready for review April 15, 2026 02:07
@qlrd qlrd requested a review from odudex April 15, 2026 02:08
@qlrd qlrd force-pushed the docs/contrib-guidelines branch from f4a2cec to 67cf800 Compare April 15, 2026 14:50
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@qlrd qlrd marked this pull request as draft April 15, 2026 21:23
@qlrd qlrd force-pushed the docs/contrib-guidelines branch 4 times, most recently from b0584cb to 7fd1f55 Compare April 15, 2026 21:42
@qlrd qlrd requested a review from odudex April 16, 2026 13:15
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md
@qlrd qlrd force-pushed the docs/contrib-guidelines branch 4 times, most recently from d0b417c to 6e9b220 Compare May 11, 2026 12:48
Comment thread CONTRIBUTING.md

#### Minimum Supported Python Version

The Minimum Supported Python Version is **3.12.0** (enforced by our CI).
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@odudex, thought if is worth to down or maintain 3.12, wdyt?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO the source of this information is pyproject.toml. No need to replicate (and maintain) it elsewhere. You can add a link to the file mentioning user can learn about all python dependencies there.
No need to lower the requirement version. This is a decision the would require testing anyway.
Let project.toml speak for itself

@qlrd qlrd marked this pull request as ready for review May 11, 2026 12:53
@qlrd qlrd requested a review from odudex May 11, 2026 12:53
@odudex
Copy link
Copy Markdown
Member

odudex commented May 11, 2026

Please ensure everything CONTRIBUTING.md states is true now. Code style, what is enforced by CI, what's not. It must be coherent with project's current status.
If new requirements and tools will later be adopted, then CONTRIBUTING can be adjusted accordingly.

@odudex
Copy link
Copy Markdown
Member

odudex commented May 11, 2026

  1. Python version is stated three different ways across the repo, and CONTRIBUTING adds a fourth conflict.
  • CONTRIBUTING.md:119 says minimum is 3.12.0 and "enforced by our CI".
  • pyproject.toml:32 requires python = "^3.12.3".
  • .github/workflows/tests.yml actually runs CI on 3.11 for every job (lint, pylint, tests, coverage).
  • The claim "enforced by our CI" is therefore false. CI doesn't enforce 3.12 at all.
  1. Markdown linting is not enforced.
  • CONTRIBUTING.md:215 says rules "are enforced by CI, both for python and markdown code" and lists markdown rules at line 278.
  • No markdown linter exists in .github/workflows/, and no .markdownlint*/.pymarkdown* config is present. There's an in-flight branch ci/pymarkdownlnt, but it hasn't landed.
  1. Conventional-commit types list is incomplete.
  • CONTRIBUTING.md:130-142 lists 8 types.
  • .github/workflows/conventional-commits.yml allows feat,fix,docs,style,refactor,test,i18n,ci,chore,git.
  • i18n and git are missing from the doc despite being CI-allowed.
  1. Fork instructions are wrong.
    • CONTRIBUTING.md:67 shows git clone git@github.com:selfcustody/krux.git under "Fork Repository". That clones upstream, not a fork. There's no instruction to actually fork via GitHub or add the upstream remote.
  2. CONTRIBUTING.md:260, 263 uses instanceof(...) — that's JavaScript. Python is isinstance(...). The "good example" wouldn't run.
  3. CONTRIBUTING.md:226-231 Python skeleton is indented 3 / 6 / 12 spaces — black (which the project uses) will rewrite to 4-space. Example contradicts the formatter that CI runs.

@qlrd qlrd force-pushed the docs/contrib-guidelines branch from 6e9b220 to 416cc4c Compare May 12, 2026 11:54
`CONTRIBUTING.md` is a important file that guides new developers through
the standards built by krux team through years. This isn't a monad and
could be changed at time to time.
@qlrd qlrd force-pushed the docs/contrib-guidelines branch from 416cc4c to 8960644 Compare May 12, 2026 11:54
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.

2 participants