update readme file

[harjotgill]

Summary by CodeRabbit

• Documentation
  • Added a CONTRIBUTING.md file with guidelines for contributing to the project.
  • Updated the README.md to enhance clarity, improve security guidelines, and provide updated usage tips and links.

[coderabbitai]

Walkthrough

The repository updates include a new CONTRIBUTING.md file providing contribution guidelines and significant enhancements to the README.md for the ast-grep-essentials package. These changes focus on security, clarity, and usability, including updated links and structured information to aid contributors and users.

Changes

File	Change Summary
CONTRIBUTING.md	New file with guidelines for contributing to the project
README.md	Updated security practices, link updates, clarity improvements, added contribution guidelines

Possibly related issues

• Ensure readme is accurate and up to date coderabbit-docs#30: The updates to README.md align with the issue's objectives to enhance documentation accuracy, organization, and user guidance.

🐰✨
A hop, a skip, a code merge deep,
Changes made, so no need to weep.
Fork and pull, the docs are clear,
Contribute with joy, have no fear!
With every commit, our project grows,
Onwards to where the codebase flows. 🌟
🐰✨

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 7f0bbc8 and 2e778b8.

Files selected for processing (2)

• CONTRIBUTING.md (1 hunks)
• README.md (2 hunks)

Files skipped from review due to trivial changes (1)

• CONTRIBUTING.md

Additional comments not posted (5)

README.md (5)

1-1: Updated package name to AST-GREP Essentials reflects a branding decision.

---

49-53: The updated directory structure descriptions for rules, utils, and tests are clear and well-organized.

---

57-85: The enhancements in the rules structure section, including detailed descriptions and examples, improve clarity and usability.

---

90-101: The updates to the tests structure section, including naming conventions and organization guidelines, standardize testing practices and enhance clarity.

---

110-110: Including a link to the Discord server in the community section encourages engagement and provides a platform for discussion.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.