08 Contributing - vagnerjsmello/NexMediator GitHub Wiki

NexMediator Logo

๐Ÿค Contributing to NexMediator

We welcome contributions of all types โ€” from fixing typos to building new features or improving documentation.

Whether you're a first-time contributor or an experienced OSS maintainer, thank you for supporting NexMediator! โญ


๐ŸŒŸ How to support the project

Even if you're not ready to contribute code yet, you can:

  • Star the repository
  • Share it with your team
  • Use it in your own projects
  • Report issues or ideas for improvement
  • Help improve the documentation

๐Ÿš€ Contribute Code

Step 1 โ€” Fork and Clone

  1. Fork the repository to your GitHub account
  2. Clone your fork locally:
git clone https://github.com/vagnerjsmello/NexMediator.git

Step 2 โ€” Create a Branch

All contributions must be made from a feature branch (never directly on main or develop):

git checkout -b feature/<short-description>

Examples:

  • feature/add-stream-request-support
  • feature/improve-caching-logging

Step 3 โ€” Make your changes

Follow the existing structure and use:

  • /// <summary> in English for all public types/methods
  • Clean naming conventions (PascalCase, camelCase, etc.)
  • One responsibility per handler, behavior, or validator

Step 4 โ€” Commit using Conventional Commits

Example formats:

  • feat: add CreateAuctionCommand
  • fix: correct TransactionBehavior error
  • docs: improve README and examples
  • chore: bump version to 1.2.0

Step 5 โ€” Push and Create a PR

git push -u origin feature/<your-feature>

Then open a Pull Request to the develop branch with a clear description.

๐Ÿงช Tests and Docs

If you add a new behavior, command, or pattern:

  • Include tests if applicable
  • Update documentation examples if needed

We aim to keep NexMediator lean, composable, and focused โ€” so contribute in ways that improve usability or extensibility.

โœ… Branch Strategy

Branch Description
main Stable production code (NuGet)
develop Active development integration
feature/* Individual features or fixes

๐Ÿ’ฌ Questions or Suggestions?

Open an issue with your idea, question, or proposal. We're happy to discuss improvements.

Thank you for making NexMediator better!

Vagner Mello May, 06, 2025

โš ๏ธ **GitHub.com Fallback** โš ๏ธ