Skip to content

Commit

Permalink
Update TODO and writing style documentation for clarity and completeness
Browse files Browse the repository at this point in the history
- Expanded the TODO list with additional tasks for Ruby, PHP, GitHub Actions, and security updates.
- Enhanced writing style guidelines by emphasizing concise language and active voice.
- Improved formatting in both TODO.md and WRITING_STYLE.md for better readability and organization.
  • Loading branch information
jonesrussell committed Jan 11, 2025
1 parent 03f12b7 commit 7da0e94
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
15 changes: 15 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,30 @@
# Maintenance TODO List

## Ruby Dependencies

- [ ] Update minima theme from "~> 2.5" to latest version
- [ ] Update jekyll-feed from "~> 0.12" to latest version
- [ ] Add explicit version constraints for csv and webrick gems
- [ ] Run `bundle update` to update all dependencies

## PHP Dependencies

- [ ] Update PHP dependencies in php-fig-guide
- [ ] Add Composer version constraints
- [ ] Set up Composer audit for security checks
- [ ] Consider adding PHP CS Fixer

## GitHub Actions

- [ ] Update Ruby setup action version
- [ ] Add caching for faster builds
- [ ] Add status checks/tests before deployment
- [ ] Consider adding automated testing workflow

## Dependabot Configuration

Update `.github/dependabot.yml` to include:

- [ ] Bundler ecosystem monitoring
- [ ] GitHub Actions monitoring
- [ ] Composer ecosystem monitoring
Expand Down Expand Up @@ -50,11 +55,13 @@ updates:
```
## Analytics
- [ ] Update Google Analytics implementation to GA4
- [ ] Review and update privacy policy accordingly
- [ ] Consider adding cookie consent banner
## Jekyll Configuration
- [ ] Add explicit timezone setting
- [ ] Update remote theme version
- [ ] Add SEO optimization settings:
Expand All @@ -67,6 +74,7 @@ updates:
- [ ] jekyll-archives
## PHP-FIG Guide
- [ ] Complete implementation of remaining PSR standards
- [ ] Add comprehensive test coverage
- [ ] Document each PSR implementation
Expand All @@ -77,13 +85,15 @@ updates:
- [ ] Implement CI/CD pipeline for PHP tests
## Security Updates
- [ ] Add security.txt file
- [ ] Add CORS headers
- [ ] Implement Content Security Policy
- [ ] Review and update SSL/TLS configuration
- [ ] Add security disclosure policy
## Documentation
- [ ] Update README with new features and configuration
- [ ] Add CONTRIBUTING.md guidelines
- [ ] Add SECURITY.md for security policy
Expand All @@ -92,18 +102,21 @@ updates:
- [ ] Document testing procedures for PHP code
## Performance
- [ ] Optimize image assets
- [ ] Implement lazy loading for images
- [ ] Add caching headers
- [ ] Consider implementing service worker for offline support
## Accessibility
- [ ] Add ARIA labels where needed
- [ ] Ensure proper heading hierarchy
- [ ] Add alt text to all images
- [ ] Test with screen readers
## Testing
- [ ] Add automated tests
- [ ] Set up CI/CD pipeline
- [ ] Add lighthouse testing
Expand All @@ -112,12 +125,14 @@ updates:
- [ ] Set up PHP test coverage reporting
## Future Considerations
- [ ] Consider implementing dark mode
- [ ] Add search functionality
- [ ] Implement commenting system
- [ ] Add RSS feed improvements
## Blog Content
- [ ] Complete PSR standards article series
- [ ] Add code examples for each PSR
- [ ] Create index page for PHP-FIG series
Expand Down
4 changes: 4 additions & 0 deletions WRITING_STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,19 +76,23 @@ description: "Compelling description"
## Language and Style

### Writing Concisely

- Avoid unnecessary adjectives like "comprehensive", "complete", "full", "robust", etc.
- Remove words that don't add value (very, really, basically, actually)
- Use active voice instead of passive
- Get to the point quickly
- If a word doesn't change the meaning when removed, remove it

### Examples

❌ Don't:

- "A comprehensive guide to PHP-FIG standards"
- "A complete tutorial that fully explains..."
- "A really useful tool that actually helps..."

✅ Do:

- "A guide to PHP-FIG standards"
- "A tutorial explaining..."
- "A tool that helps..."

0 comments on commit 7da0e94

Please sign in to comment.