Skip to content

Commit 778b182

Browse files
committed
feat: add helpful rake help task with organized task overview
- Add rake help task showing commonly used commands with categories - Include quick start guide and usage examples - Update README to mention rake help as starting point - Organize tasks by: Development, Code Quality, Release Management - Provide clear guidance for new contributors
1 parent 6565985 commit 778b182

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,9 @@ docker run -p 3000:3000 --env-file .env slack-github-threads
209209
### Running Tests
210210

211211
```bash
212+
# Show available rake tasks and quick start guide
213+
bundle exec rake help
214+
212215
# Run all CI checks (recommended for development)
213216
bundle exec rake ci
214217

Rakefile

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,42 @@ end
1313
# Default task
1414
task default: :test
1515

16+
# Help task - show commonly used tasks
17+
desc 'Show commonly used rake tasks'
18+
task :help do
19+
puts "\n🚀 slack-github-threads - Available Rake Tasks\n\n"
20+
21+
puts "📋 Development:"
22+
puts " rake test # Run all tests"
23+
puts " rake ci # Run all CI checks (syntax + rubocop + tests)"
24+
puts " rake server # Start the development server"
25+
puts " rake install # Install dependencies"
26+
puts ""
27+
28+
puts "🔧 Code Quality:"
29+
puts " rake syntax # Check Ruby syntax"
30+
puts " rake rubocop # Run RuboCop linter"
31+
puts ""
32+
33+
puts "📦 Release Management:"
34+
puts " rake release:preview # Preview next release and changelog"
35+
puts " rake release:patch # Create patch release (bug fixes)"
36+
puts " rake release:minor # Create minor release (new features)"
37+
puts " rake release:major # Create major release (breaking changes)"
38+
puts ""
39+
40+
puts "📚 More Information:"
41+
puts " rake -T # Show all available tasks with descriptions"
42+
puts " rake -T release # Show only release-related tasks"
43+
puts ""
44+
45+
puts "💡 Quick Start:"
46+
puts " 1. Run 'rake test' to ensure everything works"
47+
puts " 2. Run 'rake release:preview' to see what would be released"
48+
puts " 3. Run 'rake release:patch' (or minor/major) to create a release"
49+
puts ""
50+
end
51+
1652
# Test task
1753
Rake::TestTask.new(:test) do |t|
1854
t.libs << 'test'

0 commit comments

Comments
 (0)