add notification_templates schema with support for email, sms, and pu…#107
Open
canicefavour wants to merge 1 commit into
Open
add notification_templates schema with support for email, sms, and pu…#107canicefavour wants to merge 1 commit into
canicefavour wants to merge 1 commit into
Conversation
Collaborator
|
please resolve conflicts and fix Ci |
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
2 participants
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.
Created a comprehensive development and onboarding guide for the NotifyChain repository to streamline contributor setup and reduce onboarding friction for new developers.
Overview
This documentation provides a complete, self-contained reference for setting up the project from scratch on a clean machine, ensuring contributors can install dependencies, configure services, run the application, execute tests, and perform code quality checks without requiring additional assistance.
Documentation Improvements
Prerequisites & Environment Requirements
Documented all required development tools, software, and supported versions.
Included installation references and dependency requirements for local development.
Clarified platform-specific considerations where applicable.
Repository Structure Guide
Added a high-level project architecture overview.
Documented the purpose and responsibility of key directories and files.
Provided a repository tree map to help contributors navigate the codebase quickly.
Local Development Setup
Created step-by-step setup instructions for a clean environment.
Documented repository cloning and dependency installation workflows.
Added environment variable configuration guidance using example configuration files.
Included database setup, migration execution, and local service initialization procedures.
Documented application startup commands for development environments.
Testing & Quality Assurance
Added instructions for running unit tests and integration tests.
Documented linting and code quality verification commands.
Included guidance for interpreting test results and resolving common issues.
Provided commands for automatically fixing supported linting violations.
Troubleshooting & Developer Experience
Added notes covering common setup problems and recovery steps.
Eliminated hidden assumptions about existing local services or infrastructure.
Improved overall developer experience by centralizing setup information into a single source of truth.
Result
New contributors can now clone the repository, configure their environment, start the application, run tests, and verify code quality using a single documentation guide. This significantly reduces setup time, improves onboarding consistency, and lowers the barrier to contributing to the NotifyChain project.
Closes #33