@@ -309,4 +309,44 @@ if __name__ == "__main__":
309309
310310______________________________________________________________________
311311
312+ ## 10. Contributing Guidelines
313+
314+ ### Issue Reporting
315+
316+ - Before opening a new issue, search existing issues to avoid duplicates
317+ - Use issue templates when available
318+ - Provide clear reproduction steps for bugs
319+ - Include environment details (OS, Python version, backend used)
320+ - For feature requests, explain the use case and expected behavior
321+
322+ ### Pull Request Process
323+
324+ 1 . ** Fork and Branch** : Fork the repository and create a feature branch from ` master `
325+ 2 . ** Make Changes** : Follow the code style guidelines and add tests for new features
326+ 3 . ** Run Tests** : Ensure all tests pass locally before submitting
327+ - Run ` pytest ` for all tests
328+ - Run ` pytest -m <backend> ` for backend-specific tests
329+ - Run ` ruff check . ` for linting
330+ - Run ` mypy src/cachier/ ` for type checking
331+ 4 . ** Commit** : Use clear, descriptive commit messages
332+ 5 . ** Submit PR** : Reference related issues and provide a clear description of changes
333+ 6 . ** Code Review** : Address review feedback and re-run tests as needed
334+ 7 . ** Merge** : Maintainers will merge once approved
335+
336+ ### Development Workflow
337+
338+ - ** Branch Naming** : Use descriptive names like ` feature/add-redis-backend ` , ` fix/mongo-connection-issue ` , ` docs/update-readme `
339+ - ** Commit Messages** : Use clear, present-tense messages (e.g., "Add Redis backend support", not "Added Redis backend support")
340+ - ** Testing** : Always add tests for new features or bug fixes
341+ - ** Documentation** : Update README.rst and docstrings for new features
342+
343+ ### Release Process
344+
345+ - Releases are managed by maintainers
346+ - Version numbers follow semantic versioning (MAJOR.MINOR.PATCH)
347+ - Release notes are generated from PR titles and descriptions
348+ - PyPI releases are automated via GitHub Actions
349+
350+ ______________________________________________________________________
351+
312352Thank you for contributing to Cachier! These guidelines help ensure a robust, maintainable, and user-friendly package for everyone.
0 commit comments