From 975a886f9c6fc1ca22193ab64f6268b511fb5ac9 Mon Sep 17 00:00:00 2001 From: Val <59147281+vminojosa@users.noreply.github.com> Date: Tue, 19 Nov 2024 13:49:36 -0500 Subject: [PATCH] Update contributing.md --- docs/developers/contributing.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/developers/contributing.md b/docs/developers/contributing.md index bf5b28d765..fc6239c79b 100644 --- a/docs/developers/contributing.md +++ b/docs/developers/contributing.md @@ -37,7 +37,9 @@ If you are developing a new plugin or extension there are two different reposito The main `jspsych` repository is open to new plugins and extensions that are likely to be widely used. We require that contributions to main repository are well documented and tested before they are merged. Contributions to the main repository must use TypeScript. We limit contributions to this repository because once a plugin or extension is in the main codebase we are generally committed to providing updates as we develop new versions of jsPsych. Each new plugin and extension potentially increases the amount of development work that we will need to do in the future, so we are somewhat selective about what we will merge. If you have an idea that you'd like to discuss please [open a discussion thread](https://github.com/jspsych/jsPsych/discussions/new) and we'd love to chat about it! -The `jspsych-contrib` repository is open to any contributions that are complete and working code. There are some minimal guidelines in place about basic documentation that should be provided. Contributors can choose whether to develop their plugin or extension using our [TypeScript template](https://github.com/jspsych/jspsych-contrib/tree/main/packages/plugin-template-ts) or using our [JavaScript template](https://github.com/jspsych/jspsych-contrib/tree/main/packages/plugin-template). Contributions to `jspsych-contrib` are not evaluated for general usefulness in the same way that contributions to the main repository are. We also periodically consider whether to move contributions into the main repository from `jspsych-contrib` based on their popularity and completeness (documentation and testing). +The `jspsych-contrib` repository is open to any contributions that are complete and working code. There are some minimal guidelines in place about basic documentation that should be provided. Contributors can choose whether to develop their plugin or extension using our [TypeScript template](https://github.com/jspsych/jspsych-contrib/blob/main/templates/plugin-template-ts/src/index.ts) or using our [JavaScript template](https://github.com/jspsych/jspsych-contrib/blob/main/templates/plugin-template-js/src/index.js). Our [plugin development documentation](https://www.jspsych.org/latest/developers/plugin-development/) offers more detailed information for each approach. For example, those relying on the Typescript template can use the `npm run build` command to compile their `index.ts` code into Javascript files, while those templating already in Javascript can run their trial code directly using the `trial()` method. + +Contributions to `jspsych-contrib` are not evaluated for general usefulness in the same way that contributions to the main repository are. We also periodically consider whether to move contributions into the main repository from `jspsych-contrib` based on their popularity and completeness (documentation and testing).