docs: add CONTRIBUTING.md file#816
Conversation
5955e70 to
ef98a0d
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
b5e9334 to
1137f7d
Compare
3cf9dd5 to
71f346a
Compare
c9202cf to
902a07d
Compare
60423df to
0b07342
Compare
0b07342 to
f4a2cec
Compare
f4a2cec to
67cf800
Compare
b0584cb to
7fd1f55
Compare
d0b417c to
6e9b220
Compare
|
|
||
| #### Minimum Supported Python Version | ||
|
|
||
| The Minimum Supported Python Version is **3.12.0** (enforced by our CI). |
There was a problem hiding this comment.
@odudex, thought if is worth to down or maintain 3.12, wdyt?
There was a problem hiding this comment.
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
|
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. |
|
6e9b220 to
416cc4c
Compare
`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.
416cc4c to
8960644
Compare
What is this PR for?
CONTRIBUTING.mdis 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:
Did you build the code and tested on device?
What is the purpose of this pull request?