museumsvictoria
Discussion: Allowing for attribution of nodel core features and recipe development
I propose the following:
- For nodel-core (this repo), a prominent section is reserved at the top of the README.md that is simple and looks a bit like this:
Significant updates to this open source project were made possible by the following:
| Feature or update | Kindly made possible by | Implemented by | When |
|---|---|---|---|
| Feature #73: Process Sandbox |  |
 |
Nov 2016 |
- for nodel-recipes, the same thing might look like this:
Significant updates to our open-source recipe collection was made by the following:
| Recipe | Kindly made possible by | Implemented by | When |
|---|---|---|---|
| Fully featured Dataton Watchpax recipe |  |
|
Jan 2020 |
-
then in Nodel we aim to have a similar worded Thanks page that can click on user browsing the Nodel frontend.
-
also when the Add node button is clicked, a similarly structured Thanks page is presented or linked to.
-
we also add a note like: Please click through to any of the above parties to talk about sharing features, discussing new features and making things happen.
-
we can introduce other formal sponsorship features into the project later.
Whatever is done, it must be super quick and easy to add attribution.
Obviously, we've got permission from all parties involved before anything is put on the site.
Steps (1) and (2) are easy and I'd like to start doing that now.
Steps (3) and (4) require development work of course. That can be done later.
I really like this in principle. There are some changes I would like to suggest:
-
README.mdincludes a summary, and not a table of all contributions. It could become cumbersome. A separate markdownCONTRIBUTION.mdcould contain the full list. - nodelhost releases to be accompanied by implementer/contributor table.
- recipe's individual
README.mdto include table.
The README.md as opposed to a CONTRIBUTION.md might use this format instead of the table.
Organisation Support
Individual Developer Support
I was thinking about this some more, specifically in regards to recipes.
Perhaps in addition to a README.md giving general information about the recipe, we could include an AUTHORS.md or THANKS.md which include acknowledgments and credits on a per recipe basis.