Add 'teams' to .gitignore in templates/examples that generate a teams/ directory
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 32
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
Description
IGNORED_DIRS in tests/spfx-template-test/src/tests/templates.test.ts includes teams, which excludes the teams/ directory from template scaffolding comparison and sync. However, teams/ is not listed in the .gitignore files of the templates or examples that generate it (e.g. webpart-react).
The teams/ directory should be added to the .gitignore of each template/example that generates it, so that the traversal skips it naturally via the gitignore matcher rather than relying on the hardcoded IGNORED_DIRS list. This would make the exclusion self-documenting and consistent with how other generated directories (e.g. dist, lib) are handled.
Alternatives considered
Removing teams from IGNORED_DIRS and including it in comparison/sync — but this would require the teams/ PNG assets to be reproducible across scaffold runs, which should be verified first.
Related
Noted as a follow-up in #231.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with tests/spfx-template-test/src/tests/templates.test.ts and its IGNORED_DIRS handling, then inspect the .gitignore files for templates and examples that generate teams/, including webpart-react. Update each relevant .gitignore and run the template scaffolding comparison and sync tests; done means generated teams/ directories are excluded through gitignore matching consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 74/100