Skip to content

Add contributing guidelines - #14

Merged
Phoenix-maho merged 1 commit into
mainfrom
docs/add-contributing-guidelines
Aug 25, 2026
Merged

Phoenix-maho merged 1 commit into
mainfrom
docs/add-contributing-guidelines

Conversation

@Phoenix-maho

Copy link
Copy Markdown
Owner

Summary

Adds CONTRIBUTING.md to document how contributors should work with SynthOps.

Why this matters

SynthOps is being developed as a professional open-source product. A contributing guide helps users and future contributors understand how to set up the project, run tests, create branches, report issues and propose changes responsibly.

This improves:

  • contributor onboarding
  • open-source readiness
  • development consistency
  • responsible synthetic data practice
  • repository maturity

Changes made

  • Added CONTRIBUTING.md
  • Documented local development setup
  • Documented branching and commit guidance
  • Documented testing expectations
  • Documented responsible synthetic data contribution principles

Testing

Ran the full test suite locally.

Result:

51 passed

@Phoenix-maho
Phoenix-maho merged commit c76d617 into main Aug 25, 2026
1 check passed
@Phoenix-maho
Phoenix-maho deleted the docs/add-contributing-guidelines branch August 25, 2026 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant