HoshinoKoji/jsPsych
1
0
Fork 0
mirror of https://github.com/jspsych/jsPsych.git synced 2025-05-10 11:10:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update contributing.md

Browse Source
This commit is contained in:
Val 2024-11-19 14:25:39 -05:00 committed by GitHub
parent 81beca4c3a
commit 3002063939
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/developers/contributing.md
View File

@ -39,7 +39,7 @@ The main `jspsych` repository is open to new plugins and extensions that are lik
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). 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 [`README.md` in the `jspsych-contrib` repository](https://github.com/jspsych/jspsych-contrib) offers more detailed information for each approach, alongside the CLI tools needed to get started. For example, those relying on the Typescript template can use the `npm run build` command to compile their `index.ts` code into Javascript files. Those templating already in Javascript can meanwhile run their trial code directly using the `trial()` method, as detailed in our [plugin developer documentation](github.com/jspsych/jspsych-contrib). Our [`README.md`](https://github.com/jspsych/jspsych-contrib) in the `jspsych-contrib` repository offers more detailed information for each approach, alongside the CLI tools needed to get started. For example, those relying on the Typescript template can use the `npm run build` command to compile their `index.ts` code into Javascript files. Those templating already in Javascript can meanwhile run their trial code directly using the `trial()` method, as detailed in our [plugin developer documentation](github.com/jspsych/jspsych-contrib).
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). 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).