Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update PR template with instructions regarding spell check messages #5202

Open
3 of 10 tasks
roslynwythe opened this issue Aug 14, 2023 · 4 comments
Open
3 of 10 tasks
Labels
Complexity: Medium Dependency An issue is blocking the completion or starting of another issue Draft Issue is still in the process of being created Feature: Infrastructure For changes on site technical architecture feature: spelling role: dev leads Tasks for technical leads size: 1pt Can be done in 4-6 hours

Comments

@roslynwythe
Copy link
Member

roslynwythe commented Aug 14, 2023

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

  • 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

(#4786 (comment))

@roslynwythe roslynwythe added Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing size: missing Draft Issue is still in the process of being created labels Aug 14, 2023
@github-actions github-actions bot removed the Draft Issue is still in the process of being created label Aug 14, 2023
@github-actions

This comment was marked as outdated.

@wanyuguan wanyuguan added this to the 08. Team workflow milestone Aug 19, 2023
@ExperimentsInHonesty ExperimentsInHonesty added role: dev leads Tasks for technical leads Feature: Infrastructure For changes on site technical architecture and removed role missing Feature Missing This label means that the issue needs to be linked to a precise feature label. labels Aug 27, 2023
@roslynwythe roslynwythe added Draft Issue is still in the process of being created Complexity: Medium size: 1pt Can be done in 4-6 hours Dependency An issue is blocking the completion or starting of another issue and removed size: missing Complexity: Missing labels Oct 8, 2023
@roslynwythe roslynwythe changed the title Update PR template with instructions regarding spell check annotations Update PR template with instructions regarding spell check messages Oct 8, 2023
@ExperimentsInHonesty

This comment was marked as outdated.

@ExperimentsInHonesty ExperimentsInHonesty added ready for dev lead Issues that tech leads or merge team members need to follow up on Added to dev/pm agenda labels Mar 4, 2024
@ExperimentsInHonesty
Copy link
Member

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 ExperimentsInHonesty added ready for product Dependency An issue is blocking the completion or starting of another issue and removed Dependency An issue is blocking the completion or starting of another issue labels Mar 5, 2024
@ExperimentsInHonesty ExperimentsInHonesty removed Added to dev/pm agenda ready for dev lead Issues that tech leads or merge team members need to follow up on ready for product labels Mar 5, 2024
@roslynwythe
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Dependency An issue is blocking the completion or starting of another issue Draft Issue is still in the process of being created Feature: Infrastructure For changes on site technical architecture feature: spelling role: dev leads Tasks for technical leads size: 1pt Can be done in 4-6 hours
Projects
Development

No branches or pull requests

3 participants