-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #150 from ignacio-chiazzo/cursor
Added cursorrules file
- Loading branch information
Showing
1 changed file
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|