Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 2.55 KB

Contributing to Tiny Store

We welcome contributions! This is a research project focused on demonstrating best practices in modular monolith architecture, Domain-Driven Design, and event-driven systems. Your contributions help advance the understanding of these architectural patterns.

🤝 How to Contribute

Ways you can contribute:

  1. 🐛 Report Bugs - Found an issue? Open an issue with detailed information
  2. 💡 Suggest Features - Have ideas for improvements? Share them!
  3. 📝 Improve Documentation - Help make the docs clearer and more comprehensive
  4. 🧪 Add Tests - Increase test coverage or add new test scenarios
  5. 🔧 Code Contributions - Submit pull requests for bug fixes or enhancements
  6. 📚 Share Knowledge - Write blog posts, tutorials, or examples using this project

🚀 Getting Started

  1. Fork the repository and clone your fork
  2. Create a branch for your contribution (git checkout -b feature/amazing-feature)
  3. Make your changes following the project's architecture patterns
  4. Run tests to ensure everything works (npm test)
  5. Commit your changes with clear, descriptive messages
  6. Push to your fork and open a Pull Request

📋 Contribution Guidelines

  • Follow the architecture - Maintain module boundaries and event-driven communication
  • Write tests - New features should include appropriate tests
  • Update documentation - Keep docs in sync with code changes
  • Respect boundaries - Don't break module isolation rules
  • Be descriptive - Clear commit messages and PR descriptions help reviewers

🎯 Areas for Contribution

  • Performance improvements - Optimize event handling or database queries
  • Additional bounded contexts - Implement new modules following the existing patterns
  • Testing utilities - Enhance test helpers and fixtures
  • Documentation - Improve guides, add examples, or clarify concepts
  • Code quality - Refactoring, type safety improvements, or linting fixes

📖 Research Context

This project is part of academic research. If you're contributing code or ideas that relate to the research objectives, please reference the academic section in the README and consider citing the published paper if you use this work in your own research.

❓ Questions?

Feel free to open an issue with questions or contact Maurício Carvalho at mauriciocarvalho@ita.br to discuss ideas before implementing major changes.

Thank you for contributing! 🙏