Skip to content

Commit d2efcd4

Browse files
committed
merge: incorporate community profile files (CODEOWNERS, PR template, .gitattributes, CONTRIBUTING.md)
2 parents 6be5bb3 + 50dc096 commit d2efcd4

4 files changed

Lines changed: 56 additions & 0 deletions

File tree

.gitattributes

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Auto-detect text files and normalise line endings
2+
* text=auto
3+
4+
# Force LF for source files (consistent across Windows/macOS)
5+
*.py text eol=lf
6+
*.md text eol=lf
7+
*.yml text eol=lf
8+
*.yaml text eol=lf
9+
*.spec text eol=lf
10+
*.txt text eol=lf
11+
*.json text eol=lf
12+
*.sh text eol=lf
13+
14+
# Binary files — no line-ending conversion
15+
*.png binary
16+
*.ico binary
17+
*.icns binary
18+
*.pdf binary
19+
*.exe binary
20+
*.dmg binary

.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Default owner for all files
2+
* @mrdavearms

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## What changed
2+
3+
<!-- Brief description of the change -->
4+
5+
## Checklist
6+
7+
- [ ] `pytest` passes locally
8+
- [ ] Tested on Windows
9+
- [ ] Tested on macOS (if UI changes)
10+
- [ ] No PDF files or student data committed
11+
- [ ] CHANGELOG.md updated (if user-facing change)

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
3+
Thanks for your interest in Bulk PDF Generator! This is a solo project maintained by a working school principal, so turnaround may vary.
4+
5+
## Reporting bugs or requesting features
6+
7+
The best way to contribute is through [GitHub Issues](https://github.com/mrdavearms/bulk-pdf-extractor-and-generator/issues). Please use the provided templates — they help me understand your environment and reproduce the problem.
8+
9+
## Contributing code
10+
11+
If you'd like to submit a pull request:
12+
13+
1. Fork the repository
14+
2. Create a feature branch from `main`
15+
3. Make your changes
16+
4. Run `python -m pytest tests/ -v` and ensure all tests pass
17+
5. Submit a PR against `main`
18+
19+
Please keep changes focused — one feature or fix per PR.
20+
21+
## Privacy reminder
22+
23+
**Never commit PDF files or spreadsheets containing real student data.** Use sample/dummy data for testing.

0 commit comments

Comments
 (0)