diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f83c677..56a3106 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,6 +101,30 @@ change to someone else's macro, is reviewed by a maintainer. If you want to improve someone else's macro, it's good practice to talk to the owner first in an issue or in Discussions. +## Porting a GSAK macro + +Many good OpenSAK macros will start life as a GSAK macro. Macros posted in the +GSAK macro library are public domain, so porting them is allowed — but the +GSAK community has always asked the original author and given them credit, and +we follow that tradition here: + +1. **Ask the original author first**, where possible (GSAK forum, Facebook, + e-mail). Some authors have already given permission for all their macros — + see [GSAK authors' permissions](docs/gsak-author-permissions.md). + If you can't reach the author, say so in your pull request. +2. **Credit the original author(s) in the macro's README**, with a line like: + + > This is a port of the GSAK macro *PlacedPQ*, originally written by + > Lil Devil, Kai Team, lignumaqua and Clyde. + + Link to the original macro on the GSAK forum if you can. A comment line in + the `.lua` header is a nice extra, but the README is where credit belongs. +3. **`Author` is you** — the person who wrote the OpenSAK version and will + maintain it. + +Your port is published under the MIT License like everything else in this +repository. + ## No GitHub account? Post your macro in the OpenSAK Facebook group or in the OpenSAK thread on @@ -118,4 +142,5 @@ README or example files doesn't — but if in doubt, bump it. By opening a pull request you agree that your contribution is published under the repository's [MIT License](LICENSE). Only submit code you wrote yourself or -are allowed to publish under that license. +are allowed to publish under that license. For ports of GSAK macros, see +[Porting a GSAK macro](#porting-a-gsak-macro). diff --git a/docs/gsak-author-permissions.md b/docs/gsak-author-permissions.md new file mode 100644 index 0000000..d272f1c --- /dev/null +++ b/docs/gsak-author-permissions.md @@ -0,0 +1,17 @@ +# GSAK authors' permissions + +Some GSAK macro authors have given general permission for their macros to be +ported to OpenSAK and published here under the MIT License. If an author is +listed below, you don't need to ask them again before porting one of their +macros — just give the credit they ask for. + +For everyone else, see [Porting a GSAK macro](../CONTRIBUTING.md#porting-a-gsak-macro). + +| GSAK author | Permission | Credit asked for | Given | +|---|---|---|---| +| Kai Team (Bob Long) | All of Kai Team's GSAK macros may be ported to OpenSAK and covered by MIT | Credit to "Kai Team" in the macro's README | 18 November 2026, in the OpenSAK Facebook group and by e-mail to Allan (AgreeDK) | + +## Adding an author + +If a GSAK author gives general permission, a maintainer adds a row here in a +small pull request, with where and when the permission was given. diff --git a/template/my-macro/README.md b/template/my-macro/README.md index b245aab..9b1e7ef 100644 --- a/template/my-macro/README.md +++ b/template/my-macro/README.md @@ -2,6 +2,10 @@ One or two sentences: what the macro does and why it's useful. +If this is a port of a GSAK macro, credit the original author(s) here, e.g. +"This is a port of the GSAK macro *Name*, originally written by Author." +Otherwise delete this paragraph. + ## What it needs - OpenSAK with macro API version 3 or newer