Skip to content

Comments

Add more guidlines to the CONTRIUBITING.md.#979

Merged
arkid15r merged 2 commits intoOWASP:mainfrom
ahmedxgouda:feature/updating-contributing-guidlines
Mar 2, 2025
Merged

Add more guidlines to the CONTRIUBITING.md.#979
arkid15r merged 2 commits intoOWASP:mainfrom
ahmedxgouda:feature/updating-contributing-guidlines

Conversation

@ahmedxgouda
Copy link
Collaborator

Make the guidelines about the issues more detailed for contributors.

@ahmedxgouda ahmedxgouda requested a review from arkid15r as a code owner March 2, 2025 20:08
@github-actions github-actions bot added the docs Improvements or additions to documentation label Mar 2, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 2, 2025

Summary by CodeRabbit

  • Documentation
    • Enhanced contribution guidelines for clearer bug reporting and feature requests.
    • Introduced recommendations for new contributors to start with beginner-friendly issues.
    • Updated instructions for requesting issue assignments to improve the contribution process.

Walkthrough

The pull request updates the contributor guidelines in the CONTRIBUTING.md file. Contributors are now instructed to open a new issue for bugs or feature requests and are required to request maintainers to assign them an issue before submitting a pull request. Additionally, newcomers are encouraged to start with issues labeled as good first issue. The changes aim to enhance the clarity and specificity of the contribution process, with no modifications made to the declarations of exported or public entities.

Changes

File Change Summary
CONTRIBUTING.md Revised instructions for contributors: advises opening a new issue for bugs/feature requests, mandates obtaining issue assignment before PR submission, and recommends starting with good first issue.
(No public API changes) No alterations to the declarations of exported or public entities were made.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 96e047e and 65d11a3.

📒 Files selected for processing (1)
  • CONTRIBUTING.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CONTRIBUTING.md
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Run backend tests
  • GitHub Check: Run frontend unit tests
  • GitHub Check: CodeQL (python)
  • GitHub Check: Run frontend e2e tests
  • GitHub Check: CodeQL (javascript-typescript)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@arkid15r arkid15r moved this to In progress in Project Nest Mar 2, 2025
@arkid15r arkid15r enabled auto-merge March 2, 2025 20:17
@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 2, 2025

Copy link
Collaborator

@arkid15r arkid15r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Thanks for improving this @ahmedxgouda

@arkid15r arkid15r added this pull request to the merge queue Mar 2, 2025
Merged via the queue into OWASP:main with commit 7728724 Mar 2, 2025
18 checks passed
@github-project-automation github-project-automation bot moved this from In progress to Done in Project Nest Mar 2, 2025
@ahmedxgouda
Copy link
Collaborator Author

Thank you for the invitation :)

@ahmedxgouda ahmedxgouda deleted the feature/updating-contributing-guidlines branch March 3, 2025 06:06
shdwcodr pushed a commit to shdwcodr/Nest that referenced this pull request Jun 5, 2025
* Add more guidlines to the CONTRIUBITING.md.

* Update code

---------

Co-authored-by: Arkadii Yakovets <arkadii.yakovets@owasp.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants