Skip to content

Add Functions

Where

Create or update a module under particula//.

Checklist

  • Python – no I/O or global state changes.
  • Follow Code Specifications for formatting.
  • Input validation via util.validate_inputs when applicable.
  • Logging: use logger = logging.getLogger("particula") and log at DEBUG.

Steps

  1. Create a new issue on GitHub and assign it to yourself.
  2. Create a branch on your forked repo for this issue.
  3. Add a new function(s) to the appropriate module in particula//.
  4. Add a package __init__.py export only when the function is an approved public API. Concrete, staged, or internal-module contracts may deliberately remain unexported.
  5. If the function is a helper, add prefix _ to the function name.
  6. Write a docstring.
  7. Add type hints for all parameters and return values.
  8. Add Unit Tests for the function (see Add Unit Tests).
  9. Commit this file in a branch.
  10. Create your pull‑request to the main repo.