Skip to content

docs: add CONTRIBUTING.md file#816

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

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 (e2a8bf7) to head (7fd1f55).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #816   +/-   ##
========================================
  Coverage    97.31%   97.31%           
========================================
  Files           83       83           
  Lines        10614    10614           
========================================
  Hits         10329    10329           
  Misses         285      285           

☔ 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
- style: formatting, missing semi colons, etc; no code change;
- test: adding missing tests or correcting existing tests.

It is strongly encouraged that you
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.

Why?

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.

TY, forgot about that one. I changed a code a little, do not know if i put a TL;DR about. IMO, commits should have the same "verify" behaviour that we have when sign asset releases.

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 code speaks for itself, and doesn't require a signature (who made it shouldn't be an evaluation criteria)

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 3 times, most recently from 2598edd to b0584cb Compare April 15, 2026 21:39
`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 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
All files should have the MIT license with updated years from when we stated
the project (2021) until today (2026 when writing this document).

#### New features
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 this section's requirements are not coherent with our code

Comment thread CONTRIBUTING.md
return bar_str + baz_str
```

### Markdown
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.

Is it linted?

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