The Value Object Pattern is a Python 🐍 package that streamlines the creation and management of value objects 📦 in your projects. Value objects are immutable, self-validating objects that represent descriptive aspects of the domain with no conceptual identity. This pattern is essential for maintaining clean 🧹, maintainable, and bug-resistant 🐛 codebases by encapsulating domain-specific logic and ensuring consistency across your application 📱.
You can install Value Object Pattern using pip:
pip install value-object-patternWe welcome contributions to Value Object Pattern! To ensure a smooth collaboration process, please follow the guidelines below.
1. Fork the Repository: Click the "Fork" button at the top right of the repository page.
2. Clone Your Fork:
git clone git+ssh://git@github.com/<your-username>/value-object-pattern3. Create a Branch:
git checkout -b feature/your-feature-name4. Make Your Changes: Implement your new feature or fix a bug.
5. Run Tests: Ensure all the following tests pass before submitting your changes.
- Run tests:
make test- Run tests with coverage:
make coverage- Run linter:
make lint- Run formatter:
make format6. Commit Your Changes:
git commit -m "✨ feature: your feature description"7. Push to Your Fork:
git push origin feature/your-feature-name8. Create a Pull Request: Navigate to the original repository and create a pull request from your fork.
9. Wait for Review: Your pull request will be reviewed by the maintainers. Make any necessary changes based on their feedback.
This project is licensed under the terms of the MIT license.