From 22bfd870dd020a56b5046a241652a4744d07c3af Mon Sep 17 00:00:00 2001 From: Suchethan021 <150219759+Suchethan021@users.noreply.github.com> Date: Thu, 3 Apr 2025 16:48:34 +0530 Subject: [PATCH 1/2] feat: implement repository governance standards --- .github/CODEOWNERS | 15 ++++++ .github/ISSUE_TEMPLATE/bug_report.md | 30 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 ++++++++ .../ISSUE_TEMPLATE/repository_enhancement.md | 41 ++++++++++++++++ CODE_OF_CONDUCT.md | 47 +++++++++++++++++++ CONTRIBUTING.md | 40 ++++++++++++++++ SECURITY.md | 15 ++++++ 7 files changed, 207 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/repository_enhancement.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..3f25eb8 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,15 @@ +# Default owners for everything in the repo +* @MandarapuMadhulatha @sandeepkunkunuru @vinod-dega + +# Frontend code ownership +/frontend/ @MandarapuMadhulatha @sandeepkunkunuru + +# Python implementation ownership +*.py @MandarapuMadhulatha @sandeepkunkunuru + +# Documentation ownership +/docs/ @MandarapuMadhulatha @sandeepkunkunuru +*.md @MandarapuMadhulatha @sandeepkunkunuru + +# GitHub specific files +.github/ @vinod-dega diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..0ebed79 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug Report +about: Create a report to help us improve +title: '[BUG] ' +labels: bug +assignees: '' +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment:** + - OS: [e.g. Windows, Linux] + - Python Version: [e.g. 3.8] + - Browser (if applicable): [e.g. chrome, safari] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bfbf8ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/repository_enhancement.md b/.github/ISSUE_TEMPLATE/repository_enhancement.md new file mode 100644 index 0000000..55a8f20 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/repository_enhancement.md @@ -0,0 +1,41 @@ +--- +name: Repository Enhancement +about: Suggest improvements to repository structure, workflow, or infrastructure +title: '[REPO] ' +labels: infrastructure, enhancement +assignees: '@vinod-dega' +--- + +**Area of Enhancement** +- [ ] Repository Configuration +- [ ] CI/CD Pipeline +- [ ] Documentation +- [ ] Security +- [ ] Developer Experience +- [ ] Other + +**Current State** +Describe the current state of the area you want to enhance. + +**Proposed Changes** +List the specific changes or improvements you're proposing: +1. +2. +3. + +**Benefits** +Explain how these changes will benefit: +- [ ] Code Quality +- [ ] Development Speed +- [ ] Security +- [ ] Contributor Experience +- [ ] Other: _____ + +**Implementation Checklist** +- [ ] Configuration changes required +- [ ] Documentation updates needed +- [ ] Team training/communication needed +- [ ] Security implications considered + +**Additional Context** +Add any other context, references, or screenshots about the enhancement here. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..251fea2 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,47 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +## Our Standards + +Examples of behavior that contributes to a positive environment: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior: + +* The use of sexualized language or imagery, and sexual attention or advances +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information without explicit permission +* Other conduct which could reasonably be considered inappropriate + +## Enforcement Responsibilities + +Project maintainers are responsible for clarifying and enforcing standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the project team at support@vaidhyamegha.com. All +complaints will be reviewed and investigated promptly and fairly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..864e749 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing Guidelines + +## Pull Request Process + +1. Fork the repository +2. Create your feature branch (`git checkout -b feature/amazing-feature`) +3. Commit your changes (`git commit -m 'Add some amazing feature'`) +4. Push to the branch (`git push origin feature/amazing-feature`) +5. Open a Pull Request + +## Pull Request Requirements + +- Keep changes focused and atomic +- Update documentation as needed +- Include tests for new features +- Ensure all checks pass +- Get approval from code owners + +## Branch Naming + +- Features: `feature/description` +- Bug fixes: `fix/description` +- Documentation: `docs/description` + +## Commit Messages + +Format: +``` +type: description + +[optional body] +``` + +Types: `feat`, `fix`, `docs`, `test`, `refactor` + +## Getting Help + +- Open an issue with a clear description +- Check existing documentation +- Contact maintainers if needed diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..8651bff --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,15 @@ +# Security Policy + +## Reporting a Vulnerability + +If you believe you have found a security vulnerability in this project, please report it to us by emailing support@vaidhyamegha.com. + +**Please do not report security vulnerabilities through public GitHub issues.** + +Please include: +- Description of the vulnerability +- Steps to reproduce +- Potential impact +- Any possible solutions you've considered + +We will respond within 48 hours and work with you to address the issue. From 34a72af4d2a2566388d97ffc1dfdfca80cf6a246 Mon Sep 17 00:00:00 2001 From: Suchethan021 <150219759+Suchethan021@users.noreply.github.com> Date: Thu, 3 Apr 2025 17:16:57 +0530 Subject: [PATCH 2/2] added pip install -e . to the dependencies installation in test.yml --- .github/workflows/test.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index de590fa..c7ac817 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -23,6 +23,7 @@ jobs: python -m pip install --upgrade pip pip install -r requirements.txt pip install pytest + pip install -e . - name: Run tests run: |