githubtraining / write-github-script

Course repo for Learning Lab course GitHub Actions: Using GitHub Script
https://lab.github.com/githubtraining/github-actions:-using-github-script
Creative Commons Attribution 4.0 International
6 stars 8 forks source link

Suggestion: meaningful PR names #5

Open hectorsector opened 4 years ago

hectorsector commented 4 years ago

I know we talked a little bit about PR names already, @mattdavis0351, but whether or not we validate the names of the learner's PR, I think we should definitely be suggesting meaningful PR names. This would help any learner better digest the work they're performing. If they want to accept the default Create my-workflow.yml or Update my-workflow.yml that's fine and their prerogative, but overall it would make a much nicer learning experience if their final repo had PRs that reflected the work they did, like Use GitHub-script to comment on a newly created issue and Use a workflow to put a new issue in triage.

mattdavis0351 commented 4 years ago

I agree with this, it was strictly left as default to speed up the testing of this course while also allowing for simpler validation of pull names in the config.

I still don't see why we can't just let them name it whatever we want and store than in a variable which we can reference if we need to fix mistakes

hectorsector commented 4 years ago

I still don't see why we can't just let them name it whatever we want and store than in a variable which we can reference if we need to fix mistakes

The more I work with the store the more I agree with this statement. I do think we should suggest meaningful titles even if we don't validate against them.

mattdavis0351 commented 4 years ago

@hectorsector just updated the pull titles. Could you double check them, I'm horrible at naming this kind of thing 😛