Skip to content

docs: Add contributing guidelines#22

Closed
qlrd wants to merge 28 commits into
mainfrom
docs/contributing-guidelines
Closed

docs: Add contributing guidelines#22
qlrd wants to merge 28 commits into
mainfrom
docs/contributing-guidelines

Conversation

@qlrd

@qlrd qlrd commented Mar 26, 2026

Copy link
Copy Markdown
Owner
  • Add CONTRIBUTING.md with workflow, review, coding, testing, and release guidance;
  • Format CHANGELOG.md entries for consistency;

joaozinhom and others added 28 commits December 16, 2025 16:16
@joaozinhom
Add devices refact (selfcustody#183)
b522897
@qlrd
fix: replace typing.re for typing.Pattern (selfcustody#189)
8bdc8bf 
This commit replaces the two places where a regular expression was typed
as `typing.re` by `typing.Pattern`.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@qlrd
chore(pylint): comment the unsupported suggestion-mode option (self…
39003af 
…custody#191)
@dependabot
Bump actions/upload-artifact from 5 to 6 (selfcustody#192)
a59169f 
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 5 to 6.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@v5...v6)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
Bump urllib3 from 2.6.0 to 2.6.2 (selfcustody#193)
8a517c4 
Bumps [urllib3](https://github.com/urllib3/urllib3) from 2.6.0 to 2.6.2.
- [Release notes](https://github.com/urllib3/urllib3/releases)
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
- [Commits](urllib3/urllib3@2.6.0...2.6.2)

---
updated-dependencies:
- dependency-name: urllib3
  dependency-version: 2.6.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@qlrd
ci: add conventional commits to krux-installer (selfcustody#190)
d1f4f06 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@dependabot
chore: bump poethepoet from 0.38.0 to 0.39.0 (selfcustody#198)
5b26744 
Bumps [poethepoet](https://github.com/nat-n/poethepoet) from 0.38.0 to
0.39.0.
- [Release notes](https://github.com/nat-n/poethepoet/releases)
-
[Commits](nat-n/poethepoet@v0.38.0...v0.39.0)

---
updated-dependencies:
- dependency-name: poethepoet
  dependency-version: 0.39.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...



Co-authored-by: qlrddev@proton.me

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@joaozinhom
refactor:remove pillow, zbar and opencv (selfcustody#196)
5b8f016
@dependabot
chore: bump cryptography from 46.0.3 to 46.0.4 (selfcustody#209)
2cfa4cf 
Bumps [cryptography](https://github.com/pyca/cryptography) from 46.0.3 to 46.0.4.
- [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst)
- [Commits](pyca/cryptography@46.0.3...46.0.4)

---
updated-dependencies:
- dependency-name: cryptography
  dependency-version: 46.0.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore: bump webiny/action-conventional-commits from 1.3.0 to 1.3.1 (s…
da43dd0 
…elfcustody#208)

Bumps [webiny/action-conventional-commits](https://github.com/webiny/action-conventional-commits) from 1.3.0 to 1.3.1.
- [Release notes](https://github.com/webiny/action-conventional-commits/releases)
- [Commits](webiny/action-conventional-commits@v1.3.0...v1.3.1)

---
updated-dependencies:
- dependency-name: webiny/action-conventional-commits
  dependency-version: 1.3.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore: bump pyinstaller from 6.17.0 to 6.18.0 (selfcustody#206)
6aefc2a 
Bumps [pyinstaller](https://github.com/pyinstaller/pyinstaller) from 6.17.0 to 6.18.0.
- [Release notes](https://github.com/pyinstaller/pyinstaller/releases)
- [Changelog](https://github.com/pyinstaller/pyinstaller/blob/develop/doc/CHANGES.rst)
- [Commits](pyinstaller/pyinstaller@v6.17.0...v6.18.0)

---
updated-dependencies:
- dependency-name: pyinstaller
  dependency-version: 6.18.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore: bump black from 25.12.0 to 26.1.0 (selfcustody#207)
e311d80 
Bumps [black](https://github.com/psf/black) from 25.12.0 to 26.1.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@25.12.0...26.1.0)

---
updated-dependencies:
- dependency-name: black
  dependency-version: 26.1.0
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore: bump tomli from 2.3.0 to 2.4.0 (selfcustody#203)
0b0ef03 
Bumps [tomli](https://github.com/hukkin/tomli) from 2.3.0 to 2.4.0.
- [Changelog](https://github.com/hukkin/tomli/blob/master/CHANGELOG.md)
- [Commits](hukkin/tomli@2.3.0...2.4.0)

---
updated-dependencies:
- dependency-name: tomli
  dependency-version: 2.4.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore: bump poethepoet from 0.39.0 to 0.40.0 (selfcustody#204)
db331f0 
Bumps [poethepoet](https://github.com/nat-n/poethepoet) from 0.39.0 to 0.40.0.
- [Release notes](https://github.com/nat-n/poethepoet/releases)
- [Commits](nat-n/poethepoet@v0.39.0...v0.40.0)

---
updated-dependencies:
- dependency-name: poethepoet
  dependency-version: 0.40.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@joaozinhom
feat: add wonder_k device and test coverage (selfcustody#202)
c448bc5 
This commit adds support for the wonder_k device in krux-installer:
- USB Vendor ID: 1a86:7523
- Board type: dan
- Follows same configuration pattern as dock, yahboom, wonder_mv, and
embed_fire devices
@joaozinhom
Fix build issues (selfcustody#210)
7ea102b 
* fix: win and macos builds

In this commit i fix the pillow transformation adding the files that
each one of the builds asks for.

* fix: missed from the last PR format after bump versions
@joaozinhom
fix: ESC button kill aplication and red circles appear when another m…
4d9c9d8 
…ouse buttons are clicked. (selfcustody#211)

* fix: ESC button kill aplication and red circles appear when another inputs are received

I made this to avoid simple kill the aplication when i click ESC button,
now the ESC button back one page, and to solve the red circles bug that
appears when another mouse inputs are received instead of the left
button.

* fix: formatting that scape from the rebase

* test: adding cov
@dependabot
chore: bump cryptography from 46.0.4 to 46.0.5 (selfcustody#214)
b4b5556 
Bumps [cryptography](https://github.com/pyca/cryptography) from 46.0.4 to 46.0.5.
- [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst)
- [Commits](pyca/cryptography@46.0.4...46.0.5)

---
updated-dependencies:
- dependency-name: cryptography
  dependency-version: 46.0.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore: bump pyinstaller from 6.18.0 to 6.19.0 (selfcustody#213)
e6e87f4 
Bumps [pyinstaller](https://github.com/pyinstaller/pyinstaller) from 6.18.0 to 6.19.0.
- [Release notes](https://github.com/pyinstaller/pyinstaller/releases)
- [Changelog](https://github.com/pyinstaller/pyinstaller/blob/develop/doc/CHANGES.rst)
- [Commits](pyinstaller/pyinstaller@v6.18.0...v6.19.0)

---
updated-dependencies:
- dependency-name: pyinstaller
  dependency-version: 6.19.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore: bump pylint from 4.0.4 to 4.0.5 (selfcustody#218)
9119a2e 
Bumps [pylint](https://github.com/pylint-dev/pylint) from 4.0.4 to 4.0.5.
- [Release notes](https://github.com/pylint-dev/pylint/releases)
- [Commits](pylint-dev/pylint@v4.0.4...v4.0.5)

---
updated-dependencies:
- dependency-name: pylint
  dependency-version: 4.0.5
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore: bump poethepoet from 0.41.0 to 0.42.0 (selfcustody#217)
9639f10 
Bumps [poethepoet](https://github.com/nat-n/poethepoet) from 0.41.0 to 0.42.0.
- [Release notes](https://github.com/nat-n/poethepoet/releases)
- [Commits](nat-n/poethepoet@v0.41.0...v0.42.0)

---
updated-dependencies:
- dependency-name: poethepoet
  dependency-version: 0.42.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@joaozinhom
fix: solve artix problem (selfcustody#220)
7e12a54
@dependabot
chore: bump poethepoet from 0.42.0 to 0.42.1 (selfcustody#222)
10e99b4 
Bumps [poethepoet](https://github.com/nat-n/poethepoet) from 0.42.0 to 0.42.1.
- [Release notes](https://github.com/nat-n/poethepoet/releases)
- [Commits](nat-n/poethepoet@v0.42.0...v0.42.1)

---
updated-dependencies:
- dependency-name: poethepoet
  dependency-version: 0.42.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore: bump actions/upload-artifact from 6 to 7 (selfcustody#221)
1267dc5 
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 6 to 7.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@v6...v7)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@joaozinhom
fix: add Tor proxy support for Tails OS (selfcustody#223)
c6a9275 
* fix: add Tor proxy support for Tails OS

* chore: retrigger CI
@dependabot
chore: bump black from 26.1.0 to 26.3.0 (selfcustody#224)
4883336 
Bumps [black](https://github.com/psf/black) from 26.1.0 to 26.3.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@26.1.0...26.3.0)

---
updated-dependencies:
- dependency-name: black
  dependency-version: 26.3.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
chore: bump black from 26.3.0 to 26.3.1 (selfcustody#226)
fb965ef 
Bumps [black](https://github.com/psf/black) from 26.3.0 to 26.3.1.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@26.3.0...26.3.1)

---
updated-dependencies:
- dependency-name: black
  dependency-version: 26.3.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@qlrd
docs: add contributing guidelines
8b7a0eb 
A `CONTRIBUTING.md` file is a start point where every project should
share with a new potential developer. Also, the edition of
`CHANGELOG.md` was necessary to comply with some of those contributing
guidelines.

Signed-off-by: Monsieur Piscinette <monsieur-piscinette@selfcustody.org>
@qlrd qlrd closed this Mar 26, 2026
@codecov-commenter

codecov-commenter commented Mar 26, 2026

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 99.00990% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 98.59%. Comparing base (f8949ef) to head (8b7a0eb).

Files with missing lines Patch % Lines
src/app/__init__.py 96.00% 0 Missing and 1 partial ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.
Additional details and impacted files 
@@           Coverage Diff           @@
##             main      #22   +/-   ##
=======================================
  Coverage   98.58%   98.59%           
=======================================
  Files          63       63           
  Lines        3187     3270   +83     
  Branches      272      290   +18     
=======================================
+ Hits         3142     3224   +82     
  Misses         26       26           
- Partials       19       20    +1

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@qlrd @codecov-commenter @joaozinhom