Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (32 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 1.35 KB
Raw

Contributing

Thank you for improving originplot.

Scope

This repository contains a skill for automating Origin/OriginPro figures from external Python. Changes should improve how users design or generate Origin/OriginPro external Python automation workflows.

Good contributions include:

  • Clearer originpro automation patterns.
  • Better FigureSpec schema fields or examples.
  • More precise guidance for workbooks, matrices, graph pages, graph layers, templates, exports, and OPJU archives.
  • Small example specs that demonstrate real plotting workflows.
  • Documentation fixes that reduce ambiguity.

Avoid committing:

  • Large generated figures.
  • .opju project files.
  • Raw experiment datasets.
  • Machine-specific paths, credentials, or local Origin installation details.

Design Rules

  • Keep originplot-skill/SKILL.md focused on essential instructions.
  • Move long schemas, examples, and detailed reference material into separate files linked from SKILL.md.
  • Prefer concise examples over broad explanations.
  • Preserve the external Python + OriginPro separation:
computation outside Origin
data normalization in Python
visual style mostly in Origin templates
automation and batching in Python
final rendering in OriginPro

Pull Requests

Please include:

  • What changed.
  • Why the change helps users.
  • Any Origin/OriginPro version assumptions.