3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update contributing documentation 

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2024-04-24 07:51:42 -04:00
parent 2bf6d609cb
commit b631ec44bb
No known key found for this signature in database
GPG Key ID: 5A1EB336DFB4C71B
1 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/contributing.md
View File

@ -1,10 +1,28 @@
# Contributing to Moonraker # Contributing to Moonraker
While Moonraker exists as a service independently from Klipper, it relies Prior to submitting a pull request prospective contributors must read this
on Klipper to be useful. Thus, the tentative plan is to eventually merge entire document. Care should be taken to [format git commits](#git-commit-format)
the Moonraker application into the Klipper repo after Moonraker matures, correctly. This eases the review process and provides the reviewer with
at which point this repo will be archived. As such, contributing guidelines confidence that the submission will be of sufficient quality.
are near those of Klipper:
Prospective contributors should consider the following:
- Does the contribution have significant impact? Bug fixes to existing
functionality and new features requested by 100+ users qualify as
items of significant impact.
- Has the submission been well tested? Submissions with substantial code
change must include details about the testing procedure and results.
- Does the submission include blocking code? Moonraker is an asynchronous
application, thus blocking code must be avoided.
- If any dependencies are included, are they pure python? Many low-powered SBCs
running Armbian do not have prebuilt wheels and are not capable of building wheels
themselves, thus breaking updates on these systems.
- Does the submission change the API? If so, could the change potentially break
frontends using the API?
- Does the submission include updates to the documentation?
When performing reviews these are the questions that will be asked during the
initial stages.
#### New Module Contributions #### New Module Contributions