adding a special namespace for easy contributing #362
Replies: 5 comments 14 replies
-
That sounds interesting. How does it work with jsPsych? Do you also publish separate packages as a contributor or do you do pull requests into their main repository? |
Beta Was this translation helpful? Give feedback.
-
jsPsych consists of a core repository, maintained by the core team, and a contrib repository, where users can contribute their own plugins and extensions. Anyone can contribute to both repositories, but the core team is responsible for maintaining and publishing the core repository, while contributions to the contrib repository are reviewed by the team but are not necessarily maintained or updated regularly. |
Beta Was this translation helpful? Give feedback.
-
So, in short: the contribution gets pulled into a main repository but is still published as an individual package. |
Beta Was this translation helpful? Give feedback.
-
I think namespacing the contributions also has the advantage that it clearly distinguishes between "core" and thoroughly reviewed packages, and outside contributions, while making it easy to contribute. When the user imports something from "contrib" it is clear, that this is on their own risk and it might break other code. |
Beta Was this translation helpful? Give feedback.
-
We should discuss having a separate repo for outside contributions then. I think that nicely complements the more rigorous sub-package solution. We could also run both and see which is most adapted. |
Beta Was this translation helpful? Give feedback.
-
We could add a special namespace (for example, contrib) to autora (so src->autora->contrib), under which we could allow for easier contribution than in the src->autora namespace. That way, we can have contributors that don't want to bother that much with documentation or other details and quickly publish under the autora-contrib namespace (we would still have some form of qualitiy control but less strict, for example we wouldn't require tests, certain aspects of naming conventions, documentation..., and in the core-documentation, we would maybe only provid a link to these contib packages). If contributors (or we) want to contribute to the autora namespace directly, (src->autora) namespace, we would have a much higher review process.
Beta Was this translation helpful? Give feedback.
All reactions