diff --git a/docs/developers/contributing.md b/docs/developers/contributing.md index dc232db0..30ac3cf8 100644 --- a/docs/developers/contributing.md +++ b/docs/developers/contributing.md @@ -8,6 +8,10 @@ The project is managed entirely through the [GitHub repository](https://github.c * Use [issues](https://github.com/jspsych/jsPsych/issues) to identify anything with an actionable next step. For example, a page in the documentation that needs to be fixed, a bug in the code, or a specific feature that has a clear scope. * Submit a [pull request](https://github.com/jspsych/jsPsych/pulls) with modifications to the codebase. Pull requests will be reviewed by one or more members of the core team. +We also have two community repositories for new plugins, extensions and experiment timelines. +New plugins and extensions should be contributed to the [`jspsych-contrib`](https://github.com/jspsych/jspsych-contrib) repository, and new timelines should be contributed to the [`jspsych-timelines`](https://github.com/jspsych/jspsych-timelines) repository. +Detailed guidelines for contributing to these repositories can be found in their respective readme files. + ## Guidelines for contibuting ### Contributing to the codebase @@ -20,7 +24,7 @@ We welcome contributions of any scope. Before we can merge changes into the main * **An example file should be included if applicable.** If you are contributing a new feature, new plugin, or new extension, or contributing a modification that changes the behavior of the library in some important way, consider adding an example file to the `/examples` folder in the repository. -* **If you are contributing a plugin/extension, we strongly encourage including a file containing citation information.** This file should be named `CITATION.cff` and placed at the root of your repository. This allows people who use your plugin/extension in their code to easily cite your work by calling `jsPsych.getCitations([])` from their command line. More information on `.cff` files can be found [here](https://citation-file-format.github.io/). +* **If you are contributing a plugin/extension/timeline, we strongly encourage including a file containing citation information.** This file should be named `CITATION.cff` and placed at the root of your repository. This allows people who use your plugin/extension/timeline in their code to easily cite your work by calling `jsPsych.getCitations([])` from their command line. More information on `.cff` files can be found [here](https://citation-file-format.github.io/). * **A changeset must be included in the pull request**. We use [changesets](https://github.com/atlassian/changesets/blob/main/docs/adding-a-changeset.md) to generate new releases and their corresponding release notes. [This is a good overview of changesets](https://github.com/atlassian/changesets/blob/main/docs/adding-a-changeset.md) that explains how to add one to your pull request. Feel free to ask for help with this! diff --git a/docs/developers/extension-development.md b/docs/developers/extension-development.md index f8c44dd4..2b3d505d 100644 --- a/docs/developers/extension-development.md +++ b/docs/developers/extension-development.md @@ -15,6 +15,8 @@ As of version 7.0, extensions are [JavaScript Classes](https://developer.mozilla Plugins can be written in either plain JavaScript or in TypeScript. Template files for both [JavaScript](https://github.com/jspsych/jspsych-dev/blob/main/packages/new-extension/templates/extension-template-js/src/index.js) and [TypeScript](https://github.com/jspsych/jspsych-dev/blob/main/packages/new-extension/templates/extension-template-ts/src/index.ts) are available in the [jspsych-dev repository](https://github.com/jspsych/jspsych-dev/). +To get started with a template, we recommend using the CLI tool [`new-extension`](https://github.com/jspsych/jspsych-dev/tree/main/packages/new-extension) that we have published in [jspsych-dev](https://github.com/jspsych/jspsych-dev/tree/main). This tool automates the setup of a new extension in either JavaScript or TypeScript. Additional information about the CLI tool is available in the [`README`](https://github.com/jspsych/jspsych-dev/tree/main/packages/new-extension/README.md) of the tool. + ## Extension components ### constructor() diff --git a/docs/developers/plugin-development.md b/docs/developers/plugin-development.md index ef749533..7926f6df 100644 --- a/docs/developers/plugin-development.md +++ b/docs/developers/plugin-development.md @@ -12,7 +12,7 @@ As of version 7.0, plugins are [JavaScript Classes](https://developer.mozilla.or Templates for plugins are available in the [jspsych-dev](https://github.com/jspsych/jspsych-dev) repository. Plugins can be written in either plain [JavaScript](https://github.com/jspsych/jspsych-dev/tree/main/packages/new-plugin/templates/plugin-template-js/src/index.js) or in [TypeScript](https://github.com/jspsych/jspsych-dev/tree/main/packages/new-plugin/templates/plugin-template-ts/src/index.ts). -To get started with a template, we recommend using the CLI tools that we have published in jspsych-dev. These tools automate the setup of a new plugin in either JavaScript or TypeScript. Additional information about the CLI tools is available in the [`README`](https://github.com/jspsych/jspsych-dev/blob/main/README.md) of jspsych-dev. +To get started with a template, we recommend using the CLI tool [`new-plugin`](https://github.com/jspsych/jspsych-dev/tree/main/packages/new-plugin) that we have published in [jspsych-dev](https://github.com/jspsych/jspsych-dev/tree/main). This tool automates the setup of a new plugin in either JavaScript or TypeScript. Additional information about the CLI tool is available in the [`README`](https://github.com/jspsych/jspsych-dev/tree/main/packages/new-plugin/README.md) of the tool. ## Plugin components diff --git a/packages/extension-webgazer/README.md b/packages/extension-webgazer/README.md index 6d88c4e2..796e4687 100644 --- a/packages/extension-webgazer/README.md +++ b/packages/extension-webgazer/README.md @@ -45,3 +45,5 @@ The project is currently managed by the core team of Josh de Leeuw ([@jodeleeuw] jsPsych was created by [Josh de Leeuw](http://www.twitter.com/joshdeleeuw). We're also grateful for the generous support from a [Mozilla Open Source Support award](https://www.mozilla.org/en-US/moss/), which funded development of the library from 2020-2021. + +Strittmatter, Y., Spitzer, M., Ging-Jehli, N., & Musslick, S. (2023, November 7). A jsPsych Touchscreen Extension for Behavioral Research on Touch-Enabled Interface. https://doi.org/10.31234/osf.io/akzwj \ No newline at end of file