website icon indicating copy to clipboard operation
website copied to clipboard

Update PR template with instructions regarding spell check messages

Open roslynwythe opened this issue 2 years ago • 4 comments

Dependencies

  • [x] #4101
  • [x] #5652
  • [ ] https://github.com/hackforla/website/issues/5312
  • [ ] https://github.com/hackforla/website/issues/5450
  • [ ] https://github.com/hackforla/website/issues/5248
  • [ ] New wiki page "How to manage spell check warnings" ??
  • [ ] #5248
  • [ ] #6446

Overview

We need to direct developers how to manage spell check messages on changed files locally, and also those that may appear in Pull Request checks. Developers will be instructed to correct spelling errors where appropriate, modifying cspell.json as appropriate to suppress false positives, and to note changes in a new section of the PR template "What changes did you make in response to code linter recommendations?"

Action Items

  • [ ] Open the file .github/pull_request_template.md in your IDE
  • [ ] Following the section "Why did you make the changes (we will use this info to test)?" add this section:
Note to developers:
- [ ] If spell check warnings ("unknown word") are displayed either locally (in VS Code Spell Check Extension) or in GitHub PR checks, follow instructions in "How to manage spell check warnings"
- [ ] Alternatively, create a new issue based on the template "Resolve Spell Check warning"
- [ ] If any file changes are made in response to linter warnings, document those in the pull request, in the section "What changes did you make?

Resources/Instructions

(https://github.com/hackforla/website/issues/4786#issuecomment-1670584024)

roslynwythe avatar Aug 14 '23 23:08 roslynwythe

Hi @roslynwythe.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing: Complexity, Role, Feature

NOTE: Please ignore the adding proper labels comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards. To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.

Additional Resources:

github-actions[bot] avatar Aug 14 '23 23:08 github-actions[bot]

@roslynwythe is this ready for the prioritized backlog, and does it really have to be a dev lead or is that from before we were encouraging all members to make issues?

ExperimentsInHonesty avatar Mar 04 '24 03:03 ExperimentsInHonesty

at the 2024-03-04 dev/pm meeting we reviewed this issue and it seems like we need to figure out how this affects new developers on the project.

ExperimentsInHonesty avatar Mar 05 '24 01:03 ExperimentsInHonesty

@ExperimentsInHonesty we decided that the initial PR instructions were too complex for junior developers. I edited the action items so that developers have a wiki page "How to manage spell check warnings" to refer to for instructions, and they also can create an issue with a new template "Resolve Spell Check Warning".

roslynwythe avatar Mar 11 '24 03:03 roslynwythe