Contributing to mWEEP

Manual

Any type of contributions to the manual are welcome. You can submit contributions to the git repository at https://codeberg.org/themaklin/msweep-user-manual.

Code

Source code for msweep-rs is available at https://codeberg.org/themaklin/msweep-rs. Contributions are welcome.

msweep-rs relies on the following code for certain key parts in the pipeline:

• Pseudoalignment processing: ahda.
• Statistical inference: mixt.
• Computing k-mer distances: sketchlib.rust.
• Sequence assembly: sparrowhawk-asm.

If your contribution concerns one of these parts, prefer making it to the particular project’s repository.

LLM policy

Contributions that are mostly/entirely produced by LLMs (“generative AI”) are not accepted in msweep-rs nor in the manual.

You must disclose any LLM usage when making a pull request.

If you believe that a feature should be added, prefer opening an issue instead of submitting an LLM generated pull request.