From 804ac9b397a9bbef694edb88f1e44eea9a01afb5 Mon Sep 17 00:00:00 2001 From: Dhairya Gothi Date: Sat, 28 Sep 2024 01:43:37 +0530 Subject: [PATCH] PR --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++ .github/ISSUE_TEMPLATE/custom.md | 10 +++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++ .../\342\236\225-documentation-update-.md" | 10 +++ .github/pull_request_template.md | 80 +++++++++++++++++++ .github/workflows/add-contributors.yml | 36 +++++++++ .github/workflows/auto-comment-on-issue.yml | 35 ++++++++ .github/workflows/autocomment-issue-close.yml | 29 +++++++ .github/workflows/autocomment-pr-raise.yml | 36 +++++++++ .github/workflows/autocomment.yaml | 39 +++++++++ .github/workflows/github-actions-demo.yml | 18 +++++ backend/.gitignore | 2 + 12 files changed, 353 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/custom.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 ".github/ISSUE_TEMPLATE/\342\236\225-documentation-update-.md" create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/add-contributors.yml create mode 100644 .github/workflows/auto-comment-on-issue.yml create mode 100644 .github/workflows/autocomment-issue-close.yml create mode 100644 .github/workflows/autocomment-pr-raise.yml create mode 100644 .github/workflows/autocomment.yaml create mode 100644 .github/workflows/github-actions-demo.yml create mode 100644 backend/.gitignore diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +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. Scroll down to '....' +4. 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. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md new file mode 100644 index 0000000..48d5f81 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -0,0 +1,10 @@ +--- +name: Custom issue template +about: Describe this issue template's purpose here. +title: '' +labels: '' +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +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/\342\236\225-documentation-update-.md" "b/.github/ISSUE_TEMPLATE/\342\236\225-documentation-update-.md" new file mode 100644 index 0000000..78b1520 --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\342\236\225-documentation-update-.md" @@ -0,0 +1,10 @@ +--- +name: "βž• Documentation Update " +about: 'Adding a new project in repo ' +title: '' +labels: '' +assignees: '' + +--- + + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..fa8b14f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,80 @@ +## Related Issue + +[Cite any related issue(s) this pull request addresses. If none, simply state "None”] +write issue no. here + +## Email id used to regsiter for VSoc'24 + + +## Description + +[Please include a brief description of the changes or features added] + +## Type of PR + +- [ ] Bug fix +- [ ] Feature enhancement +- [ ] Documentation update +- [ ] Security enhancement +- [ ] Other (specify): _______________ + + +check in issue by entering [X] in boxes + +## Screenshots / Videos (if applicable) + +[Attach any relevant screenshots or videos demonstrating the changes] + +## Checklist +- [ ] I have performed a self-review of my code. +- [ ] I have read and followed the Contribution Guidelines. +- [ ] I have tested the changes thoroughly before submitting this pull request. +- [ ] I have provided relevant issue numbers, screenshots, and videos after making the changes. +- [ ] I have commented my code, particularly in hard-to-understand areas. +- [ ] I have followed the code style guidelines of this project. +- [ ] I have checked for any existing open issues that my pull request may address. +- [ ] I have ensured that my changes do not break any existing functionality. +- [ ] Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently. +- [ ] I have read the resources for guidance listed below. +- [ ] I have followed security best practices in my code changes. + +check in issue by entering [X] in boxes +## Additional Context + +[Include any additional information or context that might be helpful for reviewers.] + + + + +## Contribution Guidelines + +Thank you for considering contributing to our project! To ensure smooth collaboration and effective contribution management, please adhere to the following guidelines: + +### Issue Creation + +1. **Limit on Issues:** + - Each contributor is allowed to create a maximum of **4 issues per day**. This helps us manage and address issues efficiently. + +### Contribution Levels + +2. **Basic Contributions:** + - This project is primarily focused on documentation. Most of the setup has been completed, so contributors will generally need to work on basic code tasks, such as writing tests. + - For these tasks, issues will be assigned the **Easy** label. + +3. **Acknowledging Hard Work:** + - If a contributor puts in significant effort on a task, the issue will be upgraded to **Medium**. This is our way of recognizing and appreciating extra effort. + +4. **Feature Additions and Component Work:** + - Contributors working on new features or components using JSX/TSX will be assigned a level based on the complexity and quality of their work. + - The more complex and valuable the contribution, the higher the level assigned. + +### Level Definitions + +- **Easy:** + - Tasks are straightforward, such as fixing minor bugs, writing tests, or making simple documentation updates. +- **Medium:** + - Tasks require more effort, such as addressing complex bugs, improving existing features, or making substantial documentation improvements. +- **Hard:** + - Tasks are highly complex and involve significant new feature development, major refactoring, or extensive contributions to the project’s core components. + +We look forward to your contributions and appreciate your effort in helping us improve the project! diff --git a/.github/workflows/add-contributors.yml b/.github/workflows/add-contributors.yml new file mode 100644 index 0000000..950ca30 --- /dev/null +++ b/.github/workflows/add-contributors.yml @@ -0,0 +1,36 @@ +name: Add Contributors + +on: + pull_request: + types: [closed] + +jobs: + add-contributor: + if: github.event.pull_request.merged == true + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Set up Node.js + uses: actions/setup-node@v3 + with: + node-version: '20' + + - name: Install all-contributors-cli + run: npm install -g all-contributors-cli + + - name: Configure git + run: | + git config --global user.name 'github-actions[bot]' + git config --global user.email 'github-actions[bot]@users.noreply.github.com' + + - name: Add contributor + run: | + CONTRIBUTOR=$(jq -r '.pull_request.user.login' "$GITHUB_EVENT_PATH") + npx all-contributors-cli add $CONTRIBUTOR code,doc + npx all-contributors-cli generate + git add . + git commit -m "docs: add @$CONTRIBUTOR as a contributor for code, doc" + git push diff --git a/.github/workflows/auto-comment-on-issue.yml b/.github/workflows/auto-comment-on-issue.yml new file mode 100644 index 0000000..553e086 --- /dev/null +++ b/.github/workflows/auto-comment-on-issue.yml @@ -0,0 +1,35 @@ +name: Auto Comment on Issue + +on: + issues: + types: [opened] + +permissions: + issues: write + +jobs: + comment: + runs-on: ubuntu-latest + + steps: + - name: Add Comment to Issue + run: | + COMMENT=$(cat <