Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/add cursor rules, procfile addition #1072

Merged
merged 5 commits into from
Jan 10, 2025

Conversation

kga245
Copy link
Contributor

@kga245 kga245 commented Jan 10, 2025

Procfile

This is provided as a sample. It's probably going to move into .gitignore status soon but probably harmless to include now.

Syntax:

<process_type>: <command>

Why?

The Procfile is crucial for platforms like Heroku to understand how to run your application. Without it, Heroku won’t know what command to execute to start your app.

Cursor Rules

Source inspiration:

https://github.com/PatrickJS/awesome-cursorrules

Approach

Created two files.

  1. One is the .cursorrules file which
  2. Two is a human readable version of it

Added gitignores for all of the above. Not everyone needs it. Changes to it should be done sparingly.

Why?

Cursor uses to standardize the responses. If we have developer who are using Cursor, then it's behooves us to standardize accordingly and share our results.

kga245 added 5 commits January 7, 2025 19:44
- Add .cursorrules file for Cursor AI configuration
- Add CURSOR_RULES.md as human-readable documentation
- Include project structure, guidelines, and best practices
- Add AI integration rules and development workflows
Added cursor rules files (actual and reader friendly versions, both)
Updated cursor rules to include fastapi and python deployment rules
Merge master into feature/add-cursor-rules to sync with latest upstream changes
@ElishaKay ElishaKay merged commit e074659 into assafelovic:master Jan 10, 2025
@kga245 kga245 deleted the feature/add-cursor-rules branch February 3, 2025 23:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants