ReadAlongs / Studio-Web

Suite of web packages for creating interactive ReadAlongs (this repo was formerly called Web-Component)
https://readalong-studio.mothertongues.org/
Other
9 stars 9 forks source link

docs: add a PR template and a Contributing.md file #273

Closed joanise closed 4 months ago

joanise commented 4 months ago

PR Goal?

To add a standard template guiding PR submitters to provide better comments for reviewers.

Also, noticed that there was no Contributing.md. I added one, but I think it needs more work...

Fixes?

n/a

Feedback sought?

If you're happy with the template, which I'm using here, and suggestions for fleshing out Contributing.md

Priority?

low

Tests added?

n/a

How to test?

You can try it out with this link: https://github.com/joanise/just-testing/compare/main...dev.gzip-on-ci-all-OSs?expand=1&template=studio_web_pr_template.md

Confidence?

The template works fine in EveryVoice already, so I assume it'll be good here, but low confidence in Contributing.md

Version change?

no

github-actions[bot] commented 4 months ago

PR Preview Action v1.4.7 :---: :rocket: Deployed preview to https://ReadAlongs.github.io/Studio-Web/pr-preview/pr-273/ on branch gh-pages at 2024-05-01 14:05 UTC