Add Cursor Rules

Author: apd10

.cursor/rules/conda_env.mdc

@@ -0,0 +1,12 @@
+---
+description: sparse_attention_hub conda
+alwaysApply: true
+---
+Every project is associated with a conda environment. before starting to run any commands, run the following
+```
+bash
+```
+followed by
+```
+conda activate sparse_attention_hub
+```

.cursor/rules/defensive-coding.mdc

@@ -0,0 +1,18 @@
+---
+description: when to do defensive and when not to do defensive coding
+globs: *.py
+alwaysApply: true
+---
+
+Follow these instructions when writing any python code
+
+1. Keep code minimal by focusing only on the logic needed for the task.
+2. Trust internal invariants in self-contained projects—don't check for impossible conditions.
+3. Avoid unnecessary type checks or error handling when inputs are fully controlled.
+4. Use assertions during development to catch unexpected states, but remove or reduce them in production if they're redundant.
+5. Apply defensive coding only when dealing with:
+    a. External inputs (user data, files, APIs)
+    b. Unreliable dependencies
+    c. Long-lived or reused code (e.g. libraries, shared modules)
+6. Prioritize readability and maintainability over protecting against unrealistic edge cases.
+

.cursor/rules/doctstring-python.mdc

@@ -0,0 +1,39 @@
+---
+description: docstring format to use in python
+globs: *.py
+alwaysApply: true
+---
+
+While writing python code, always ensure to add correct formatted docstrings to classes and methods.
+
+An example format of a good docstring is below
+
+
+"""Example Google style docstrings.
+
+This module demonstrates documentation as specified by the `Google Python
+Style Guide`_. Docstrings may extend over multiple lines. Sections are created
+with a section header and a colon followed by a block of indented text.
+
+Example:
+    Examples can be given using either the ``Example`` or ``Examples``
+    sections. Sections support any reStructuredText formatting, including
+    literal blocks::
+
+        $ python example_google.py
+
+Section breaks are created by resuming unindented text. Section breaks
+are also implicitly created anytime a new section starts.
+
+Attributes:
+    module_level_variable1 (int): Module level variables may be documented in
+        either the ``Attributes`` section of the module docstring, or in an
+        inline docstring immediately following the variable.
+
+        Either form is acceptable, but the two should not be mixed. Choose
+        one convention to document module level variables and be consistent
+        with it.
+
+Todo:
+    * For module TODOs
+"""

.cursor/rules/linting.mdc

@@ -0,0 +1,30 @@
+---
+description: Linters when success is confirmed 
+globs:
+alwaysApply: false
+---
+
+When the conversation is about to end and task is a success, ask if linters should be run. If yes
+run the following linters and fix the linting issues
+
+```bash
+    black --check --line-length=88 sparse_attention_hub tests scripts
+```
+
+```bash
+        isort \
+            --profile=black \
+            --line-length=88 \
+            --multi-line=3 \
+            -p sparse_attention_hub \
+            sparse_attention_hub tests scripts
+```
+
+```bash
+    flake8 \
+        --max-line-length=88 \
+        --extend-ignore=E203,W503,E501 \
+        --exclude=build,dist,.git,__pycache__,.pytest_cache,.venv \
+        sparse_attention_hub tests scripts
+```
+

.cursor/rules/python-type-annotations.mdc

@@ -0,0 +1,9 @@
+---
+description: Strong type annotations
+globs: *py
+alwaysApply: true
+---
+
+While writing python code, always use strong type annotations in the following places
+1. method signatures
+2. while declaring new variables in code

.cursor/rules/tests.mdc

@@ -0,0 +1,10 @@
+---
+description: tests
+globs:
+alwaysApply: true
+---
+
+when writing tests, remember to 
+1. use the sparse-attention-hub/tests directory and appropriate file structure mimicing the code file structure from sparse-attention-hub/sparse_attention_hub/
+2. You are free to add new tests
+3. If modifying the tests, always ask before making changes.

.cursor/rules/type-annotations.mdc

@@ -0,0 +1,9 @@
+---
+alwaysApply: true
+---
+while writing python code,
+
+Always use Type annotations for the generating code including but not limited to
+1. Method parameters and return types
+2. Class members
+3. actual code of the form b = f (a), use b: Type = f(a)