cardano-foundation / developer-portal

The Cardano Developer Portal
https://developers.cardano.org
MIT License
381 stars 918 forks source link

PR template - add `yarn.lock` advisement #1288

Closed rphair closed 3 months ago

rphair commented 3 months ago

Inspired by recent discussion in https://github.com/cardano-foundation/developer-portal/pull/1286#issuecomment-2264314918 / https://github.com/cardano-foundation/developer-portal/pull/1286#issuecomment-2264424587.

Most yarn.lock issues have to be dealt with after the fact and we see it more often than not with new contributors. Therefore this should help to reduce workload by not having to coordinate removing yarn.lock with contributors repeatedly, while assuring a more focused contributor / editor workload on the Portal.

The language is key of course, so as not to call too much attention to a problem that contributors might not have (a justification for keeping it brief, and for keeping the detailed instructions parenthetical)... so feedback about the wording is welcome.

How this currently appears (the last Checklist item in all 3 cases):