docs: refresh README to reflect production state and add CONTRIBUTING guide - #16
Closed
senagul wants to merge 2 commits into
Closed
docs: refresh README to reflect production state and add CONTRIBUTING guide#16senagul wants to merge 2 commits into
senagul wants to merge 2 commits into
Conversation
…BUTING guide — README used to say 'aktif gelistirme, iskelet tamamlandi' with a checkbox roadmap where nothing was checked; twelve merged PRs later it now describes the actual system (docker+compose, SigNoz observability, MediatR CQRS handler, per-recipient multi-channel dispatcher, health endpoints, GitHub Actions CI, 47 tests) with the correct tech stack table, real endpoint list, and observability section pointing at deployment.environment=Production; CONTRIBUTING introduces the trunk-based workflow, branch naming conventions, conventional commit format, squash-merge policy, and documents the main branch protection rules (no direct push, CI required, no force push, no delete); both files stripped of Turkish characters to sidestep the cp1252-vs-utf8 encoding trap that already burned us three times this week
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CONTRIBUTING guide — README used to say 'aktif gelistirme, iskelet tamamlandi' with a checkbox roadmap where nothing was checked; twelve merged PRs later it now describes the actual system (docker+compose, SigNoz observability, MediatR CQRS handler, per-recipient multi-channel dispatcher, health endpoints, GitHub Actions CI, 47 tests) with the correct tech stack table, real endpoint list, and observability section pointing at deployment.environment=Production; CONTRIBUTING introduces the trunk-based workflow, branch naming conventions, conventional commit format, squash-merge policy, and documents the main branch protection rules (no direct push, CI required, no force push, no delete); both files stripped of Turkish characters to sidestep the cp1252-vs-utf8 encoding trap that already burned us three times this week