hackforla / website

Hack for LA's website
https://www.hackforla.org
GNU General Public License v2.0
316 stars 754 forks source link

Update PR template with instructions regarding spell check messages #5202

Open roslynwythe opened 1 year ago

roslynwythe commented 1 year ago

Dependencies

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



### Resources/Instructions
(https://github.com/hackforla/website/issues/4786#issuecomment-1670584024)
github-actions[bot] commented 1 year ago

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:

ExperimentsInHonesty commented 6 months ago

@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 commented 6 months ago

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.

roslynwythe commented 6 months ago

@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".