.windsurfrules: Create file based on dev-loop

tmux-python · tony · Feb 27, 2025 · Feb 27, 2025 · Feb 27, 2025 · Feb 27, 2025
commit 3e059d6d454a1b0355c21abd042b0e8f893ff9dc
diff --git a/.windsurfrules b/.windsurfrules
@@ -0,0 +1,77 @@
+# libtmux Python Project Rules
+
+<project_stack>
+- uv - Python package management and virtual environments
+- ruff - Fast Python linter and formatter
+- py.test - Testing framework
+  - pytest-watcher - Continuous test runner
+- mypy - Static type checking
+- doctest - Testing code examples in documentation
+</project_stack>
+
+<coding_style>
+- Use a consistent coding style throughout the project
+- Format code with ruff before committing
+- Run linting and type checking before finalizing changes
+- Verify tests pass after each significant change
+</coding_style>
+
+<python_docstrings>
+- Use reStructuredText format for all docstrings in src/**/*.py files
+- Keep the main description on the first line after the opening `"""`
+- Use NumPy docstyle for parameter and return value documentation
+- Format docstrings as follows:
+  ```python
+  """Short description of the function or class.
+
+  Detailed description using reStructuredText format.
+
+  Parameters
+  ----------
+  param1 : type
+      Description of param1
+  param2 : type
+      Description of param2
+
+  Returns
+  -------
+  type
+      Description of return value
+  """
+  ```
+</python_docstrings>
+
+<python_doctests>
+- Use narrative descriptions for test sections rather than inline comments
+- Format doctests as follows:
+  ```python
+  """
+  Examples
+  --------
+  Create an instance:
+
+  >>> obj = ExampleClass()
+
+  Verify a property:
+
+  >>> obj.property
+  'expected value'
+  """
+  ```
+- Add blank lines between test sections for improved readability
+- Keep doctests simple and focused on demonstrating usage
+- Move complex examples to dedicated test files at tests/examples/<path_to_module>/test_<example>.py
+- Utilize pytest fixtures via doctest_namespace for complex scenarios
+</python_doctests>
+
+<testing_practices>
+- Run tests with `uv run py.test` before committing changes
+- Use pytest-watcher for continuous testing: `uv run ptw . --now --doctest-modules`
+- Fix any test failures before proceeding with additional changes
+</testing_practices>
+
+<git_workflow>
+- Make atomic commits with conventional commit messages
+- Start with an initial commit of functional changes
+- Follow with separate commits for formatting, linting, and type checking fixes
+</git_workflow>