Skip to main content

Contributing

Welcome​

Welcome to the Myrmic contribution guide. This page focuses on improving the documentation and keeping it accurate and usable.

Why Contribute?​

Documentation evolves with the product. Contributing to docs is a great entry point for beginners and a way for experienced contributors to clarify complex topics for the community.

By improving the docs, you help new users succeed faster and help existing users avoid confusion. Whether you fix a typo, fill a missing topic, or tighten an explanation, your contribution matters.

GitHub Workflow​

If you're new to GitHub, read the GitHub Open Source Guide to learn how to fork a repository, create a branch, and submit a pull request.

Where to Contribute​

Docs and code both live in the official repository, with the docs under doc/chapters/. If you notice a gap, an unclear step, or a missing topic, you are welcome to open an issue or a pull request.

The contribution guide is a good place to start. It covers the development setup, the checks CI runs, and the pull request process.

Review Process​

Once you submit your contribution, the Myrmic maintainers will review the changes, provide feedback, and merge the pull request when it is ready.

If you have questions or need help, leave a comment on your PR.

Style Guide​

This section summarizes the writing guidelines used across the Myrmic docs for contributors who are new to technical writing.

  • Clarity over completeness and one clear way instead of many options.
  • Write in direct, simple language, active voice, and present tense.
  • Address the reader as "you" and avoid hype or marketing language.
  • Use canonical terms consistently and avoid new synonyms.
  • Use headings and short paragraphs; prefer lists for steps.
  • Avoid nested lists; use separate headings instead.
  • Use TBD when something is unknown rather than guessing.
  • Any runnable steps require a technical review.

Voice​

Use a consistent voice across the docs.

  • Write clear, concise sentences and avoid tangents.
  • Prefer simple words over complex ones.
  • Use active voice and present tense.
  • Be explicit when a subject is unclear; repeat it instead of using vague "this".
  • Use second person (you/your) and gender-neutral language.
  • Avoid hype or marketing language.

Getting Help​

Licensing of contributions​

Before your first pull request can be merged, you - or your employer, if you contribute on its behalf - accept the Contributor License Agreement electronically through the CLA bot on GitHub. It keeps ownership with you and enables Myrmic's dual-licensing model. The Licensing chapter explains the model; Contributing and the CLA explains the agreement in plain language.

Cookie Policy