Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (49 loc) · 4.19 KB

CONTRIBUTING.md

File metadata and controls

84 lines (49 loc) · 4.19 KB
Raw

Contributing

Thank you for your interest in this project.

I am glad to hear from people who find the repo useful or who want to help. That said, I am not currently in a position to accept outside contributions without prior coordination.

Before Contributing

Please do not open a pull request without talking with me first.

At the moment, this repository is not open to unsolicited pull requests, including well-intentioned code, documentation, or structural cleanup changes. If a pull request arrives without prior discussion and agreement, I may close it without review.

Reaching out does not automatically mean that a contribution will be accepted. It only starts a conversation about whether collaboration makes sense for the current state of the project. I am planning to use an issue-first approach to handling pull requests.

Current Policy

For now, contributions are coordination-first, not pull-request-first.

  • Do not begin implementation work unless we have already agreed on the change.
  • Do not assume that a bug report, idea, or email implies approval to start coding.
  • Do not assume that a polished contribution is easier for me to accept than an early conversation. In practice, the opposite is often true.

This is my first repository that may attract outside contributions. I do not want to create an accidental maintainer commitment around unplanned incoming work. I also do not want to waste anyone else's time. Thank you for understanding.

How To Reach Out

If you are interested in contributing, please email me first at sdd@grafsys.com.

In that note, it helps if you briefly include:

  • what you want to change
  • why you think it would help
  • whether you are proposing discussion, implementation help, or longer-term collaboration

If a change looks like a good fit, we can decide together whether to continue by email, move the discussion into a GitHub issue, or define a scoped implementation path.

If We Decide To Collaborate

If we agree to work on something, I will usually want us to align on the following before any pull request is opened:

  • the problem being solved
  • whether the change fits current priorities
  • the intended scope and boundaries
  • the validation or tests needed
  • any documentation or example updates that should land with the change

That agreement should happen before implementation starts, not after a PR is already written.

Contributor License Agreement

This repository uses a coordination-first contribution process and also requires written acceptance of the Contributor License Agreement before I will accept or merge outside contributions.

The agreement text is in CLA.md.

If we decide to collaborate, the expected order is:

  • we first agree that the contribution is in scope
  • you read CLA.md
  • you send written acceptance by email or another written electronic record that I accept
  • only after that should implementation proceed toward a pull request or patch review

The simplest acceptance sentence is:

I have read and agree to the Contributor License Agreement in CLA.md for my contributions to this repository.

For clarity, a DCO sign-off, commit sign-off, or pull request statement is not a substitute for written acceptance of the CLA unless I explicitly agree otherwise in writing.

Project Context

This repository is still evolving, and some parts of it are under active architectural and renderer-migration work. Uncoordinated changes can easily create review burden or cut across decisions that are still in motion.

If you want technical context before reaching out, these are the best starting points:

Looking Ahead

If the contribution process becomes more open in the future, this document will change with it. At that point, it will likely grow into a more standard GitHub contribution guide with issue, test, and pull request expectations.

For now, the most helpful first step is a short email rather than a pull request.

Thanks again for the interest, even if the answer is sometimes "not yet" or "not this one."