Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Immediate documentation fix for people confused by .ts plugin setup #3439

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Immediate documentation fix for people confused by .ts plugin setup #3439

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
81beca4
Update contributing.md
vminojosa Nov 19, 2024
3002063
Update contributing.md
vminojosa Nov 19, 2024
60a9a58
Update contributing.md
vminojosa Nov 19, 2024
4971d12
Update contributing.md
vminojosa Nov 21, 2024
b560575
Update plugin-development.md
vminojosa Nov 22, 2024
35c125e
Update contributing.md
vminojosa Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/developers/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,11 @@ 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).

The [`README.md`](https://github.com/jspsych/jspsych-contrib) in our `jspsych-contrib` repository offers detailed information for each approach, as well as how to start each process using CLI tools like `npm run new`. Those relying on the Typescript template can then use the `npm run build` command to compile their `index.ts` code into Javascript files. Meanwhile, those templating directly in Javascript can run their trial code using the `trial()` method, as detailed in our [plugin developer documentation](github.com/jspsych/jspsych-contrib).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the second link is incorrect?

We should probably also clarifying that the CLI tool is something that we built and is available (for the moment) only in the contrib repository. So npm run new is just the command we assigned to the CLI tool in that repository.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the second link is definitely what's linked in the jspsych website.

I can totally fix the second thing though!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would think plugin developer documentation links to https://www.jspsych.org/latest/developers/plugin-development/. Maybe it should be updated somewhere else too?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm also wondering if the edits here make more sense in that space -- as a guide for general plugin development -- rather than under the contributions piece. What do you think?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh by second link, I assumed you were referring to the one linking to the .js template. I changed both of those links as well, since each one linked to a 'file not found.'

I'll fix that right away, thanks for catching that!

As for where they make more sense, that probably works, the only downside is that the link to the contrib support is all at the bottom of that developer page, so I can see why they could end up missing it.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but yes, sorry for misunderstanding what link you were referring to, I was looking at the total changes between all of the commits.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok finally circled back to fixing what you asked in these edits, so hoping that they're good and we can chat a little about fixing the jsPsych webpages themselves today as suggested earlier?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alrighty, moved these edits to developer docs as discussed in-person yesterday. Broken links in contributing.md are still fixed too.


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).



Expand Down
Loading