Skip to content

docs: add CONTRIBUTING.md file#816

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

docs: add CONTRIBUTING.md file#816
qlrd wants to merge 1 commit intoselfcustody: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 (86340f3) to head (71f346a).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #816   +/-   ##
========================================
  Coverage    97.31%   97.31%           
========================================
  Files           83       83           
  Lines        10576    10576           
========================================
  Hits         10292    10292           
  Misses         284      284           

☔ 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 from 1137f7d to 3cf9dd5 Compare January 7, 2026 19:46
`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 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

## RTFM

We have a deep and a concise
[documentation for users](https://selfcustody.github.io). Besides
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.

broken link (404)
Use https://selfcustody.github.io/krux/


We have a deep and a concise
[documentation for users](https://selfcustody.github.io). Besides
that, not all of then read properly the documentation.
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.

unintelligible sentence


### Create a topic branch

You always start with a `master` branch initialized. While the community of
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.

master -> main

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.

Sorry was dealing with to much masters lol

will be released by one of the maintainers.

The release will have pre-built binaries available on github's asset page.
They **must** be GPG signed, and have a list of hashes for each asset.
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.

We sign with OpenSSL

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