Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
179 lines (130 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

179 lines (130 loc) · 3.64 KB
Raw

Contributing to Cursor Resources

Thank you for your interest in contributing! This project aims to be the go-to resource for Cursor IDE users and AI-assisted development best practices.

Ways to Contribute

1. Report Issues

  • Found an error in the documentation?
  • Link broken?
  • Information outdated?

Open an issue

2. Suggest Improvements

  • Have an idea for new content?
  • Know a better way to explain something?
  • Want to add a new section?

Start a discussion

3. Submit Content

  • New Cursor rules
  • Additional language guides
  • Translations
  • Cheatsheet additions

Submit a pull request

Content Guidelines

Writing Style

  • Clear and concise - Get to the point
  • Practical - Include examples and code
  • Accurate - Cite sources when possible
  • Accessible - Explain jargon when first used

Formatting

  • Use Markdown
  • Include code blocks with syntax highlighting
  • Use tables for comparisons
  • Add a table of contents for long documents

Quality Standards

  • Test code examples before submitting
  • Verify links work
  • Check spelling and grammar
  • Follow existing document structure

Submitting a Pull Request

1. Fork the Repository

git clone https://github.com/YOUR-USERNAME/Cursor.git
cd Cursor

2. Create a Branch

git checkout -b feature/your-feature-name

Use prefixes:

  • feature/ - New content
  • fix/ - Corrections
  • update/ - Updates to existing content
  • docs/ - Documentation improvements

3. Make Your Changes

Follow the existing structure and style of the repository.

4. Commit Your Changes

git add .
git commit -m "Add: Brief description of changes"

Commit message prefixes:

  • Add: - New content
  • Fix: - Bug fixes
  • Update: - Updates
  • Remove: - Deletions
  • Refactor: - Restructuring

5. Push and Create PR

git push origin feature/your-feature-name

Then open a Pull Request on GitHub.

Pull Request Template

When creating a PR, please include:

## Description
Brief description of changes

## Type of Change
- [ ] New content
- [ ] Bug fix
- [ ] Update existing content
- [ ] Translation

## Checklist
- [ ] I have tested any code examples
- [ ] I have verified all links work
- [ ] I have followed the existing style
- [ ] I have updated the table of contents (if applicable)

Content Ideas We'd Love

High Priority

  • Go language rules (.mdc)
  • Rust language rules
  • Java/Kotlin rules
  • Additional translations (French, Spanish, etc.)
  • Video tutorial links

Medium Priority

  • Framework-specific rules (Django, FastAPI, NestJS)
  • IDE configuration guides
  • Troubleshooting expansions

Nice to Have

  • Case studies from real projects
  • Team workflow guides
  • Enterprise deployment guides

Code of Conduct

Be Respectful

  • Treat all contributors with respect
  • Welcome newcomers
  • Accept constructive criticism

Be Collaborative

  • Work together, not against each other
  • Give credit where due
  • Share knowledge openly

Be Professional

  • Keep discussions on topic
  • No spam or self-promotion
  • No harassment of any kind

Recognition

All contributors will be:

  • Listed in the Contributors section
  • Credited in relevant commit messages
  • Thanked publicly (if desired)

Questions?

Thank you for making this resource better for everyone!