Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (27 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.82 KB
Raw

Contributing

This is a hobby project maintained on a part-time basis. Contributions are welcome but please calibrate expectations on response time.

Reporting issues

Most useful: a minimal reproduction.

  • Python version, matplotlib version, OS
  • The shortest snippet that triggers the issue
  • What you expected vs what you got (a screenshot helps if it's a visual issue)
  • Whether apply_style() was called before the offending plot code

Issues without a reproduction are harder to act on and may sit longer.

Proposing a feature

Open an issue first to check whether the feature fits the project's scope before writing code. The scope is narrow on purpose: rcParams + helpers + journal presets for SSCI / SCI submission figures. Things that fit:

  • Additional journal presets (with a citation to the publisher's author guidelines)
  • New CVD-safe palettes (with a color-vision-deficiency citation)
  • New chart-type helpers that follow established APA / journal conventions

Things that don't fit:

  • General-purpose plotting features that matplotlib already covers
  • Interactive / web visualization
  • Style choices that aren't grounded in a publisher specification or peer-reviewed color science

Pull requests

  • One concern per PR. Combined PRs ("fix bug X and add feature Y") are slower to review.
  • For style changes, include a before/after PNG.
  • Run python examples/generate_examples.py to confirm nothing visual regresses.
  • Match the existing code style (type hints, docstrings, snake_case).

Response time

Issue triage typically lands within a week or two. PRs may take longer if they require careful review of generated figures. If something has gone silent for a month, a polite bump is fine.

Code of conduct

Be reasonable. Disagreements about color theory or APA interpretation are welcome; disagreements about people are not.