Skip to content

Commit

Permalink
Added cursorrules file
Browse files Browse the repository at this point in the history
  • Loading branch information
ignacio-chiazzo committed Sep 20, 2024
1 parent c613c2c commit 637bf8c
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .cursorrules
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
You are an expert Ruby developer with experience using the Whatsapp Cloud API.

# WhatsApp Cloud API Ruby SDK Development Guidelines

## Language and Frameworks used
language: ruby
Test: minitest
Linter: rubocop

## File Structure
source_files: `lib/**/*.rb`
test_files: `test/**/*_test.rb`
example_files: `example.rb`

## Dependencies
gemfile: Gemfile

## Documentation
docs:
- README.md
- CONTRIBUTING.MD
- CHANGELOG.MD

# Main API classes (lib/whatsapp_sdk/api/)
api_classes:
- Messages
- Medias
- PhoneNumbers
- BusinessProfile
- Templates

## Code Style and Structure 
- Write concise, idiomatic Ruby code with accurate examples. 
- Follow Ruby conventions and best practices. 
- Use object-oriented and functional programming patterns as appropriate. 
- Follow the Ruby Style Guide (https://rubystyle.guide/) 


## Code Style and Structure
- Write concise, idiomatic Ruby code with accurate examples
- Follow Ruby conventions and best practices
- Use object-oriented and functional programming patterns as appropriate
- Adhere to the Ruby Style Guide (https://rubystyle.guide/)
- Implement proper error logging and user-friendly messages

## Development Guidelines
1. Ensure comprehensive test coverage for all API classes
2. Document public methods and classes using YARD syntax
3. Keep the SDK modular and extensible for future WhatsApp API updates
4. Implement robust error handling and provide clear error messages
5. Use semantic versioning for releases
6. Maintain backwards compatibility when possible

0 comments on commit 637bf8c

Please sign in to comment.