Skip to content

Commit 0da8b4c

Browse files
behicofbehicof
committed
Pending changes exported from your codespace
1 parent 27686c5 commit 0da8b4c

8 files changed

+13337
-0
lines changed

‎.ipynb_checkpoints/CONTRIBUTING-checkpoint.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributing Guide to CodeRabbit Documentation
2+
3+
Welcome, and thank you for considering contributing to the **CodeRabbit Documentation**. This guide will help you get started and ensure a smooth contribution process.
4+
5+
## Before You Start ✋
6+
7+
The CodeRabbit documentation repository is an open-source project aimed at creating clear, detailed, and developer-friendly documentation for CodeRabbit. Whether you're improving existing docs or adding new content, your contributions are valued.
8+
9+
## How Can I Contribute?
10+
11+
There are various ways you can contribute:
12+
13+
- **Fixing Typos or Improving Grammar**: Even small fixes like spelling errors or improving sentence structure are appreciated.
14+
- **Clarifying Existing Documentation**: If something is unclear, feel free to rewrite for better understanding and give a clear explanation in PR.
15+
- **Suggesting Structural Improvements**: Propose changes that can improve the structure and navigation of the docs.
16+
17+
### Join the Community
18+
19+
- Connect with other contributors by joining our [CodeRabbit Discord Server](https://discord.gg/coderabbit). Feel free to introduce yourself in the `#intros` channel.
20+
21+
## How to Contribute? 👨‍💻
22+
23+
### Fork and Pull Request Flow ⏳
24+
25+
1. **Fork** the repository to your GitHub account by visiting [CodeRabbit Docs GitHub repo](https://github.com/coderabbitai/coderabbit-docs).
26+
2. **Clone** your fork locally:
27+
28+
```shell
29+
git clone git@github.com:YOUR_USERNAME/coderabbit-docs.git
30+
31+
```
32+
33+
3. Create a new branch:
34+
35+
```shell
36+
git checkout -b your_username/feature_description
37+
```
38+
39+
4. Implement the changes then commit and push the changes from your working branch:
40+
41+
```shell
42+
git commit -m "docs: add explanation about [section]"
43+
git push origin your_username/feature_description
44+
```
45+
46+
## Commit Message Format 💬
47+
48+
We require all commits in this repository to adhere to the following commit message format.
49+
50+
```txt
51+
<type>: <description> (#<issue number>)
52+
53+
[optional body]
54+
```
55+
56+
This format is based on [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
57+
Please refer to the Conventional Commits specification for more details.
58+
59+
## Keeping your Fork Up-to-Date 🆕
60+
61+
To keep your fork updated with the latest changes from the upstream repository:
62+
63+
```shell
64+
git remote add upstream https://github.com/coderabbitai/coderabbit-docs.git
65+
git fetch upstream
66+
git rebase upstream/main
67+
```
68+
69+
## Contributing Best Practices 🚨
70+
71+
- Work on **one issue at a time** to avoid confusion.
72+
- If you need help, post in the `#support` channel on Discord.
73+
- Test your changes locally before submitting a PR.
74+
- While AI is cool, minimize its use for _direct team communication_. We value concise, genuine exchanges over scripted messages.

‎.ipynb_checkpoints/README-checkpoint.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
<p align="left">
2+
<a href="https://coderabbit.ai">
3+
<img src="static/img/coderabbit_nav_logo.svg" alt="CodeRabbit Logo" width="200"/>
4+
</a>
5+
</p>
6+
7+
# CodeRabbit Documentation
8+
9+
Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the code review dev tool that helps you ship quality code faster.
10+
11+
[![Website](https://img.shields.io/badge/website-coderabbit.ai-blue)](https://coderabbit.ai)
12+
[![Twitter Follow](https://img.shields.io/twitter/follow/coderabbitai?style=social)](https://twitter.com/coderabbitai)
13+
[![Discord](https://img.shields.io/discord/1134356397673414807?color=7289DA&label=Discord&logo=discord&logoColor=green)](http://discord.gg/coderabbit)
14+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/coderabbitai/coderabbit-docs/pulls)
15+
[![Node.js CI](https://github.com/coderabbitai/coderabbit-docs/actions/workflows/node.js.yaml/badge.svg)](https://github.com/coderabbitai/coderabbit-docs/actions/workflows/node.js.yaml)
16+
![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/coderabbitai/coderabbit-docs?labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit%20Reviews)
17+
18+
## About CodeRabbit
19+
20+
> **CodeRabbit** is an AI-powered code reviewer that delivers context-aware feedback on pull requests within minutes, reducing the time and effort needed for manual code reviews. It provides a fresh perspective and catches issues that are often missed, enhancing the overall review quality.
21+
22+
- Automated code reviews
23+
- Intelligent suggestions for code improvements
24+
- Pull request summary
25+
- Interactive chat
26+
- Sequence diagrams
27+
- Integration with popular version control platforms
28+
- Support for all programming languages
29+
30+
## Table of Contents
31+
32+
- [Getting Started](#getting-started)
33+
- [Project Structure](#project-structure)
34+
- [Local Development](#local-development)
35+
- [Building for Production](#building-for-production)
36+
- [Contributing](#contributing)
37+
38+
## Getting Started
39+
40+
1. Make sure that you have the following prerequisites installed:
41+
42+
- [Node.js](https://nodejs.org/)
43+
- [pnpm](https://pnpm.io/installation)
44+
45+
2. Clone this repository:
46+
47+
```sh
48+
git clone https://github.com/coderabbit-ai/coderabbit-docs.git
49+
cd coderabbit-docs
50+
```
51+
52+
3. Install Node.js dependencies using `pnpm`:
53+
54+
```sh
55+
pnpm install
56+
```
57+
58+
4. Start the development server:
59+
60+
```sh
61+
pnpm start
62+
```
63+
64+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
65+
66+
## Project Structure
67+
68+
```sh
69+
coderabbit-docs/
70+
├── blog/
71+
├── docs/
72+
├── src/
73+
│ ├── components/
74+
│ ├── css/
75+
│ └── pages/
76+
├── static/
77+
├── docusaurus.config.ts
78+
├── sidebar.ts
79+
└── package.json
80+
```
81+
82+
## Local Development
83+
84+
```sh
85+
docusaurus start
86+
```
87+
88+
This command starts a local development server and opens up a browser window.
89+
90+
## Building for Production
91+
92+
```sh
93+
docusaurus build
94+
```
95+
96+
This command generates static content into the `build` directory.
97+
98+
## Contributing
99+
100+
We welcome contributions to improve our documentation. Here are some guidelines:
101+
102+
1. Fork this repository
103+
2. Create a new branch for your changes
104+
3. Make all the changes
105+
4. Test your changes locally
106+
5. Submit a pull request with a clear description of what changes you did and why.
107+
108+
For more detailed contributing guidelines, please see our [CONTRIBUTING.md](./CONTRIBUTING.md) file.
109+
110+
---
111+
112+
For more information on using Docusaurus, please refer to the [official Docusaurus documentation](https://docusaurus.io/docs).
113+
114+
Built with ❤️ by the CodeRabbit team

‎.ipynb_checkpoints/babel.config-checkpoint.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
3+
}

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy