search

NLeSC / guide

Software Development Guide
https://guide.esciencecenter.nl
Creative Commons Attribution 4.0 International
49 stars 31 forks source link

JavaScript/TypeScript chapter is quite outdated #268

Closed egpbos closed 1 week ago

egpbos commented 2 years ago

Following #257, we should think about what to do with the JavaScript/TypeScript chapter as well. It's last major update was 4 years ago which I think is two lifetimes in JS years ;)

@jspaaks or @sverhoeven, as main authors of the current chapter, do you have any ideas on this? Others with JS/TS experience that want to weigh in?

jspaaks commented 2 years ago

Can we do without any JS/TS content in the guide? If so, I'd say delete it all

egpbos commented 2 years ago

There was an actual question yesterday from Suvayu who was looking for a good up-to-date JS/TS guide, so there does seem to be some market for it. Maybe we don't need to write such a guide ourselves, though.

I guess the possible actions I see are:

  1. Delete the chapter.
  2. Replace the chapter with references to good external guides (required action: finding good guides).
  3. Update the chapter (required action: find someone who wants to own the chapter and has time to do it).

Any candidates for 2 and 3? Maybe @ctwhome, @ewan-escience or @dmijatovic? Otherwise, like with the Java chapter, it's probably best to remove it, indeed.

jspaaks commented 2 years ago

Also,

  1. Employ a TechLead who knows what tooling is there, how to apply existing tooling, and when to use what
suvayu commented 2 years ago

If I may - I think what would be sufficient is a set of resources to get an already experienced programmer up to speed relatively easily. For example today I am sitting next to Stefan, and he quickly pointed me to a testing framework (jest), some comments about treatment of types between JS & TS, etc, and that was quite helpful.

Maybe I should keep track of the things that helps me, and that can serve as a starting template.

egpbos commented 2 years ago

Good to hear! Sitting down with an expert beats reading a guide anyway, imho, but it's probably different for everyone (and it's not always easy to find the experts).

Jest and some comments about types are present in the current Guide chapter, although I also see that Jest is just the fourth of 4 possible testing framework suggestions; are those others still recommended as well? Should we emphasize Jest and deemphasize the others?

Also, possibly the specific commands that are described for using typing are outdated, maybe someone could check those, or just remove them and point to guides of relevant tools which probably explain things better anyway?

ewan-escience commented 2 months ago

I can make some updates once in a while.

egpbos commented 2 months ago

Awesome, looking forward to the updates!