Skip to content

Docstring & Writing Guidelines

This article is part of the Developer Contribution Guidance series. It points you to the two standards every contributor follows.

You are contributing… Follow this guide Why
Python code with docstrings Docstring Guide Microbots generates its API reference directly from NumPy-style docstrings. Read this before adding or editing them so your code renders correctly and passes the numpydoc-validation check (see Pre-commit Setup).
Documentation, guides, or blog posts Technical Writing Guidelines Match the project's tone, structure, and formatting.

Conclusion

Whether you are writing code or documentation, applying the relevant guide keeps your contribution consistent with the rest of the project and helps it pass review smoothly. With these standards in hand, you have completed the Developer Contribution Guidance series and are ready to open your pull request.