From 7b5402c3f9620c372c537c2829df25b9c2224e32 Mon Sep 17 00:00:00 2001 From: Yoo-SH Date: Fri, 22 Aug 2025 00:13:33 +0900 Subject: [PATCH 1/2] feat: demo movie --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 2ab43ef..fdd4206 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,9 @@ OpenContext is an enterprise-grade RAG (Retrieval-Augmented Generation) system d - **Production Ready**: Docker Compose deployment with monitoring and logging - **Developer Friendly**: MCP protocol integration for AI assistants like Cursor +### Demo +[![demo](https://github.com/user-attachments/assets/55482003-4bb8-4316-bea7-200ecf5bf92a)](https://github.com/user-attachments/assets/55482003-4bb8-4316-bea7-200ecf5bf92ae) + ## Architecture ```mermaid From 5435ab10d5ba2c03a9235bc3a1fc53d133ccac87 Mon Sep 17 00:00:00 2001 From: Yoo-SH Date: Fri, 22 Aug 2025 00:25:10 +0900 Subject: [PATCH 2/2] docs: add comprehensive CONTRIBUTING.md guide - Add detailed contributing guidelines with code standards and community guidelines - Include Git Flow based branch strategy with naming conventions - Define pull request guidelines with templates and review process - Establish commit message conventions following conventional commits - Provide step-by-step workflow for feature development, hotfixes, and releases - Add code review guidelines and completion criteria for maintainers --- CONTRIBUTING.md | 235 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 235 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e956124 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,235 @@ +## **Contributing Guidelines** + +### Getting Started +1. Fork the repository +2. Clone your fork locally +3. Create a feature branch +4. Make your changes +5. Test your changes +6. Submit a pull request + +### Code Standards +- Follow existing code style +- Write meaningful commit messages +- Include tests for new features +- Update documentation as needed + +### Community Guidelines +- Be respectful and inclusive +- Provide constructive feedback +- Help others learn and grow +- Follow the project's Code of Conduct + + + +## **Branch Strategy** + +### Git Flow Based Branch Strategy + +#### Main Branches +- **`main`** (or `master`): Production-ready code +- **`develop`**: Integration branch for development +- **`feature/*`**: New feature development +- **`hotfix/*`**: Critical bug fixes +- **`release/*`**: Release preparation + +#### Branch Naming Convention + +``` +feature/issue-number-brief-description +hotfix/issue-number-brief-description +release/version-number +``` + +**Examples:** +``` +feature/123-user-authentication +hotfix/456-login-bug-fix +release/1.2.0 +``` + +#### Workflow + +1. **Feature Development** + ```bash + # Create feature branch from develop + git checkout develop + git pull origin develop + git checkout -b feature/123-user-authentication + + # After development, create PR to develop + ``` + +2. **Hotfix** + ```bash + # Create hotfix branch from main + git checkout main + git pull origin main + git checkout -b hotfix/456-critical-bug + + # After fix, create PRs to both main and develop + ``` + +3. **Release** + ```bash + # Create release branch from develop + git checkout develop + git pull origin develop + git checkout -b release/1.2.0 + + # After release preparation, create PR to main + ``` + +--- + +## **Pull Request Guidelines** + +### PR Title Format + +``` +type(scope): brief description + +Types: +- feat: new feature +- fix: bug fix +- docs: documentation update +- style: code formatting +- refactor: code refactoring +- test: adding/updating tests +- chore: miscellaneous tasks +``` + +**Examples:** +- `feat(auth): add social login functionality` +- `fix(api): resolve user info retrieval bug` +- `docs(readme): update installation guide` + +### PR Description Guidelines + +#### 1. Summary of Changes +- Clearly describe what was changed +- Explain why this change was necessary + +#### 2. Testing Instructions +- Provide methods to verify the changes +- Include screenshots or GIFs for UI changes + +#### 3. Related Issues +- Link related issues: `Closes #123`, `Fixes #456` + +#### 4. Checklist +- [ ] Code follows the project's style guidelines +- [ ] Self-review completed +- [ ] Appropriate tests added +- [ ] Documentation updated (if needed) + +--- + +## Pull Request Template + +```markdown +## Summary of Changes + + +## Type of Change + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update +- [ ] Code refactoring +- [ ] Performance improvement +- [ ] Test addition + +## Related Issues + +Closes #issue-number + +## Testing Instructions + +1. +2. +3. + +## Screenshots (if applicable) + + +## Checklist + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes + +## Additional Notes + +``` + +--- + +## Code Review Guidelines + +### For Reviewers + +#### Review Checklist +1. **Functionality**: Does the code work as intended? +2. **Readability**: Is the code easy to understand? +3. **Performance**: Are there any performance concerns? +4. **Security**: Are there any security vulnerabilities? +5. **Testing**: Are appropriate tests included? + +#### Feedback Guidelines +- Provide **specific and constructive** feedback +- Include **positive feedback** for good parts +- Use **suggestion format**: "What do you think about...?" +- Provide **code examples** when possible + +### Review Priority +1. **Critical**: Bugs, security issues, performance problems +2. **Major**: Design issues, readability problems +3. **Minor**: Style, naming conventions + +### Review Completion Criteria +- [ ] All Critical/Major issues resolved +- [ ] Tests passing +- [ ] Documentation updated +- [ ] At least one approval from maintainer + +--- + +## Commit Message Convention + +### Format +``` +type(scope): subject + +body + +footer +``` + +### Types +- **feat**: A new feature +- **fix**: A bug fix +- **docs**: Documentation only changes +- **style**: Changes that do not affect the meaning of the code +- **refactor**: A code change that neither fixes a bug nor adds a feature +- **perf**: A code change that improves performance +- **test**: Adding missing tests or correcting existing tests +- **chore**: Changes to the build process or auxiliary tools + +### Examples +``` +feat(auth): add OAuth2 integration + +Add support for Google and GitHub OAuth2 providers. +This allows users to sign in with their existing accounts. + +Closes #123 +``` + +--- +