Files
alchemist/CONTRIBUTING.md

2.1 KiB
Raw Blame History

Contributing to Alchemist

Thanks for your interest in contributing to Alchemist. Contributions are welcome, but please read this document carefully before submitting anything.

License

Alchemist is licensed under the GNU General Public License v3.0 (GPL-3.0).

By contributing to this project, you agree that your contributions will be licensed under the same GPL-3.0 license.

By submitting a contribution (code, documentation, assets, or any other material), you agree that:

  • You grant the project owner (Brooklyn Halmstad) a perpetual, irrevocable, worldwide right to use, modify, relicense, and redistribute your contribution as part of the project.
  • You retain copyright to your individual contribution, but you grant the project owner full rights to incorporate it into Alchemist, including future relicensing or dual-licensing if desired.
  • You confirm that you have the legal right to submit the contribution and that it is your own original work (or properly attributed and compatible with GPL-3.0).

In short: you keep authorship credit, but the project owner controls the project.

Contributor License Agreement (CLA)

At this time, no separate CLA document is required.

By opening a pull request, submitting a patch, or otherwise contributing, you are implicitly agreeing to the terms outlined in this file.

Contribution Guidelines

  • Keep changes focused and minimal.
  • Follow existing code style and architecture.
  • Do not introduce new dependencies without discussion.
  • Large or breaking changes should be discussed in an issue first.
  • All contributions must build and run cleanly.

Local Setup

For local development bootstrap, use:

just install        # macOS / Linux
just install-w      # Windows
just dev

Windows contributor support in RC.2 is limited to the core install/dev/check path. Broader utility and release recipes remain Unix-first for now.

Additional setup and workflow docs live in:

  • docs/docs/contributing/development.md
  • RELEASING.md

Low-effort PRs will be closed.

Code of Conduct

Dont be a jerk. Act in good faith. Respect other contributors.