Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (38 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 2.74 KB
Raw

Contributing to Forge

Thank you for your interest in Forge!
We truly appreciate every bit of community involvement that helps make the project better.

Contribution Model

Forge follows a split contribution model to keep the core stable and reliable:

  • ForgeCore (Runtime, parsers, interpreters, engine-level infrastructure)

    • Maintained exclusively by the core maintainer team.
    • Direct code pull requests to ForgeCore are generally not accepted.
    • Please open an issue first with a clear use case, motivation, and rough proposal. We'll discuss whether it fits the core direction and how (or if) it could be implemented.

  • Plugins, sample apps, documentation, examples & tutorials

    • This is where community contributions shine!
    • We actively welcome issues, pull requests, new plugins, doc improvements, examples, and more.

What We Love to See

  • New plugin ideas (bonus points if you include a rough PoC or draft)
  • Pull requests for plugins, examples, or docs
  • Feature suggestions backed by clear user value and real-world use cases
  • Bug reports with minimal, reproducible steps (code snippets, logs, or screenshots are gold)
  • Improvements to READMEs, guides, tutorials, example projects
  • Small wins: typo fixes, clearer explanations, new diagrams/GIFs in docs

How to Get Started

  1. Create issues via GitHub Issues (that's our single source of truth).

  2. Use helpful prefixes in issue titles to make triage easier:

    • [Plugin] – New plugin or plugin enhancement
    • [Feature] – Feature request
    • [Bug] – Bug report
    • [Docs] – Documentation / example improvement
    • [Question] – If you're unsure where something fits

The clearer the description (expected vs. actual behavior, minimal repro steps, environment info), the faster we can respond or merge.

If you're looking for a place to start, check out issues labeled good first issue (we try to tag beginner-friendly ones when possible):
good first issue Good for newcomers

Licensing of Contributions

To keep Forge maintainable under its dual-licensing model, contributions to this repository are accepted with the understanding that:

  • Your contribution can be distributed as part of Forge under GPL-3.0-or-later.
  • CrowdWare may also use and distribute your contribution under the Forge commercial licensing model.
  • You confirm you have the right to submit the contribution under these terms.

If this does not work for you, please do not submit a pull request and open an issue instead to discuss alternatives.

Thank you in advance for your time, ideas, and pull requests - every solid contribution makes Forge more powerful and enjoyable for everyone.

Happy forging! 🔨