fixed the contributors readme issue. #77
Conversation
|
@github-actions[bot] is attempting to deploy a commit to the bunty's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
Warning Rate limit exceeded@RamakrushnaBiswal has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 56 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughA new GitHub Actions workflow has been added to automate the update of the contributors list in the README file, triggered by pushes to the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊 |
|
@Sapna127 did you make it by your own |
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 14033809 | Triggered | MongoDB Credentials | d5be656 | backend/.env | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (3)
.github/workflows/contributors.yml (1)
1-18: Address YAML formatting issues.There are some minor YAML formatting issues that should be addressed to improve readability and consistency.
- Fix the indentation on line 12 (and subsequent lines) to use 2 spaces instead of 10:
permissions: contents: write pull-requests: write
- Add a newline character at the end of the file.
These changes will resolve the warnings from the YAML linter and improve the overall structure of the file.
🧰 Tools
🪛 yamllint
[warning] 12-12: wrong indentation: expected 12 but found 10
(indentation)
[error] 18-18: no new line character at the end of file
(new-line-at-end-of-file)
README.md (2)
Line range hint
46-85: LGTM with suggestion: Getting Started, Contributing, and Open Source ProgramsThe improvements to the Getting Started and Contributing sections enhance the onboarding process for new contributors. The addition of the Open Source Programs section effectively highlights the project's participation in GSSoC 2024 Extended.
However, the Mentors section currently lacks specific information:
## 🌟 Mentors Special thanks to our amazing mentors who are guiding this project! 🙌 - **[to be annouce]** - Full Stack DeveloperConsider updating this section with actual mentor information when available, or remove it temporarily if the information is not yet finalized.
🧰 Tools
🪛 Markdownlint
88-88: Column: 1
Hard tabs(MD010, no-hard-tabs)
89-89: Column: 1
Hard tabs(MD010, no-hard-tabs)
132-132: Column: 1
Hard tabs(MD010, no-hard-tabs)
133-133: Column: 1
Hard tabs(MD010, no-hard-tabs)
162-162: Column: 1
Hard tabs(MD010, no-hard-tabs)
163-163: Column: 1
Hard tabs(MD010, no-hard-tabs)
86-165: LGTM with formatting suggestions: Contributors SectionThe new table format for displaying contributors is a great improvement, aligning well with the PR objective of adding a workflow for fetching contributors. It provides a visually appealing way to recognize project contributors.
However, there are some minor formatting issues:
- Replace hard tabs with spaces for consistent indentation across different editors.
- Ensure consistent indentation throughout the table structure.
Here's a snippet of how the beginning of the table should look with these changes:
<!-- readme: contributors -start --> <table> <tbody> <tr> <td align="center"> <a href="https://github.com/RamakrushnaBiswal"> <img src="https://avatars.githubusercontent.com/u/125277258?v=4" width="100;" alt="RamakrushnaBiswal"/> <br /> <sub><b>Ramakrushna Biswal</b></sub> </a> </td> <!-- ... other contributors ... --> </tr> </tbody> </table> <!-- readme: contributors -end -->Apply this indentation style throughout the contributors table for consistency.
🧰 Tools
🪛 Markdownlint
88-88: Column: 1
Hard tabs(MD010, no-hard-tabs)
89-89: Column: 1
Hard tabs(MD010, no-hard-tabs)
132-132: Column: 1
Hard tabs(MD010, no-hard-tabs)
133-133: Column: 1
Hard tabs(MD010, no-hard-tabs)
162-162: Column: 1
Hard tabs(MD010, no-hard-tabs)
163-163: Column: 1
Hard tabs(MD010, no-hard-tabs)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- .github/workflows/contributors.yml (1 hunks)
- README.md (1 hunks)
🧰 Additional context used
🪛 yamllint
.github/workflows/contributors.yml
[warning] 12-12: wrong indentation: expected 12 but found 10
(indentation)
[error] 18-18: no new line character at the end of file
(new-line-at-end-of-file)
🪛 Markdownlint
README.md
88-88: Column: 1
Hard tabs(MD010, no-hard-tabs)
89-89: Column: 1
Hard tabs(MD010, no-hard-tabs)
132-132: Column: 1
Hard tabs(MD010, no-hard-tabs)
133-133: Column: 1
Hard tabs(MD010, no-hard-tabs)
162-162: Column: 1
Hard tabs(MD010, no-hard-tabs)
163-163: Column: 1
Hard tabs(MD010, no-hard-tabs)
🔇 Additional comments (4)
README.md (4)
Line range hint
1-30: LGTM: Introduction and Project OverviewThe changes to the introduction and the addition of the Project Overview section enhance the README by providing clearer context about the PlayCafe project and its goals. These improvements align well with the PR objectives.
🧰 Tools
🪛 Markdownlint
88-88: Column: 1
Hard tabs(MD010, no-hard-tabs)
89-89: Column: 1
Hard tabs(MD010, no-hard-tabs)
132-132: Column: 1
Hard tabs(MD010, no-hard-tabs)
133-133: Column: 1
Hard tabs(MD010, no-hard-tabs)
162-162: Column: 1
Hard tabs(MD010, no-hard-tabs)
163-163: Column: 1
Hard tabs(MD010, no-hard-tabs)
Line range hint
31-45: LGTM: Features and Tech StackThe Features and Tech Stack sections are well-maintained, providing clear information about the project's capabilities and technologies used. The minor formatting improvements in the Features section enhance readability.
🧰 Tools
🪛 Markdownlint
88-88: Column: 1
Hard tabs(MD010, no-hard-tabs)
89-89: Column: 1
Hard tabs(MD010, no-hard-tabs)
132-132: Column: 1
Hard tabs(MD010, no-hard-tabs)
133-133: Column: 1
Hard tabs(MD010, no-hard-tabs)
162-162: Column: 1
Hard tabs(MD010, no-hard-tabs)
163-163: Column: 1
Hard tabs(MD010, no-hard-tabs)
Line range hint
166-172: LGTM: Support SectionThe addition of the Support section is a great way to encourage community engagement and project sustainability. It provides clear calls-to-action for users to become sponsors and star the repository.
🧰 Tools
🪛 Markdownlint
88-88: Column: 1
Hard tabs(MD010, no-hard-tabs)
89-89: Column: 1
Hard tabs(MD010, no-hard-tabs)
132-132: Column: 1
Hard tabs(MD010, no-hard-tabs)
133-133: Column: 1
Hard tabs(MD010, no-hard-tabs)
162-162: Column: 1
Hard tabs(MD010, no-hard-tabs)
163-163: Column: 1
Hard tabs(MD010, no-hard-tabs)
Line range hint
1-172: Overall assessment: Excellent improvements to the README@Sapna127, great job on enhancing the README! The changes you've made, particularly the addition of the contributors table, align perfectly with the PR objectives and significantly improve the document's informativeness and visual appeal.
To address @RamakrushnaBiswal's question: While the implementation of the contributors table is excellent, it would be helpful to clarify whether you created this workflow yourself or if you adapted it from existing resources. This information could be valuable for future contributors and maintainers.
A few minor suggestions for further improvement:
- Update the Mentors section with specific information when available.
- Address the formatting issues in the Contributors section by replacing hard tabs with spaces and ensuring consistent indentation.
Once these small adjustments are made, this PR will be ready for merge. Great work on enhancing the project documentation!
🧰 Tools
🪛 Markdownlint
88-88: Column: 1
Hard tabs(MD010, no-hard-tabs)
89-89: Column: 1
Hard tabs(MD010, no-hard-tabs)
132-132: Column: 1
Hard tabs(MD010, no-hard-tabs)
133-133: Column: 1
Hard tabs(MD010, no-hard-tabs)
162-162: Column: 1
Hard tabs(MD010, no-hard-tabs)
163-163: Column: 1
Hard tabs(MD010, no-hard-tabs)
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - "*" |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider refining the workflow trigger.
The current trigger configuration runs the workflow on every push to any branch, which might be unnecessary for branches other than main.
Consider limiting the workflow to run only on pushes to the main branch and pull requests targeting main:
on:
push:
branches:
- main
pull_request:
branches:
- mainThis change would reduce unnecessary workflow runs while still updating the contributors list when changes are merged into the main branch.
| jobs: | ||
| contrib-readme-job: | ||
| runs-on: ubuntu-latest | ||
| name: A job to automate contrib in readme | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Job configuration looks good, but consider adding a concurrency group.
The job configuration and permissions are correctly set up. However, to prevent concurrent runs of this workflow, which could lead to conflicts when updating the README, consider adding a concurrency group.
Add a concurrency configuration to the workflow:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
contrib-readme-job:
# ... (rest of the job configuration)This addition will ensure that only one instance of this workflow runs at a time for each branch, canceling any in-progress runs if a new commit is pushed.
🧰 Tools
🪛 yamllint
[warning] 12-12: wrong indentation: expected 12 but found 10
(indentation)
| steps: | ||
| - name: Contribute List | ||
| uses: akhilmhdh/[email protected] | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Action configuration is correct, but consider adding error handling.
The step using the contributors-readme-action is correctly configured. However, it's a good practice to add error handling and provide more information about the step's purpose.
Enhance the step configuration:
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Update Contributors List in README
uses: akhilmhdh/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
continue-on-error: true
- name: Check for changes
id: git-check
run: |
git diff --exit-code || echo "changes=true" >> $GITHUB_OUTPUT
- name: Commit changes
if: steps.git-check.outputs.changes == 'true'
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add README.md
git commit -m "docs: update contributors list"
git pushThese changes add error handling, explicitly checkout the repository, and only commit changes if the README was actually modified.
🧰 Tools
🪛 yamllint
[error] 18-18: no new line character at the end of file
(new-line-at-end-of-file)
yes.. I refered this - https://github.com/marketplace/actions/contribute-list |
RamakrushnaBiswal
merged commit cab8921
into
RamakrushnaBiswal:main
RamakrushnaBiswal
added
documentation
Added the workflow for fetching the contributors to readme
Summary by CodeRabbit
New Features
Documentation