Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Sep 4, 2025. It is now read-only.

Commit05a7eb7

Browse files
authored
👷 Add markdownlint pipeline (coderabbitai#125)
* 👷 Add markdownlint pipeline* 🔧 Add CODEOWNERS file for TypeScript review assignments* 🚨 Fix all markdownlint violations* 💚 mailto* 📝 Update changelog to reflect SOC 2 Type II compliance announcement* 📝 Use canonical note admonition in semgrep
1 parent312b4d7 commit05a7eb7

21 files changed

+320
-90
lines changed

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.ts@coderabbitai/typescript-reviewers

‎.github/workflows/node.js.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name:Node.js CI
2+
3+
on:
4+
push:
5+
branches:main
6+
pull_request:
7+
branches:main
8+
9+
jobs:
10+
test:
11+
runs-on:ubuntu-latest
12+
13+
steps:
14+
-uses:actions/checkout@v4
15+
-uses:pnpm/action-setup@v4
16+
with:
17+
version:latest
18+
-uses:actions/setup-node@v4
19+
with:
20+
node-version:latest
21+
cache:pnpm
22+
-run:pnpm install --frozen-lockfile --strict-peer-dependencies
23+
-run:pnpm run build
24+
-run:pnpm run lint

‎.markdownlint-cli2.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
gitignore:true

‎.markdownlint.json‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎.markdownlint.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
default:true
2+
first-line-heading:false
3+
line-length:false
4+
link-fragments:false
5+
no-duplicate-heading:
6+
siblings_only:true
7+
no-inline-html:false
8+
single-title:false

‎.markdownlintrc‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
./docs/changelog.md

‎CONTRIBUTING.md‎

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,30 @@ There are various ways you can contribute:
2424

2525
1.**Fork** the repository to your GitHub account by visiting[CodeRabbit Docs GitHub repo](https://github.com/coderabbitai/coderabbit-docs).
2626
2.**Clone** your fork locally:
27+
2728
```shell
2829
git clone git@github.com:YOUR_USERNAME/coderabbit-docs.git
2930

31+
```
32+
3033
3. Create a new branch:
31-
```shell
32-
git checkout -b your_username/feature_description
33-
```
34+
35+
```shell
36+
git checkout -b your_username/feature_description
37+
```
3438

3539
4. Implement the changes then commit and push the changes from your working branch:
36-
```shell
37-
git commit -m"docs: add explanation about [section]"
38-
git push origin your_username/feature_description
39-
```
40+
41+
```shell
42+
git commit -m"docs: add explanation about [section]"
43+
git push origin your_username/feature_description
44+
```
4045

4146
##Commit Message Format 💬
4247

4348
We require all commits in this repository to adhere to the following commit message format.
4449

45-
```
50+
```txt
4651
<type>: <description> (#<issue number>)
4752
4853
[optional body]
@@ -52,7 +57,9 @@ This format is based on [Conventional Commits](https://www.conventionalcommits.o
5257
Please refer to the Conventional Commits specification for more details.
5358

5459
##Keeping your Fork Up-to-Date 🆕
60+
5561
To keep your fork updated with the latest changes from the upstream repository:
62+
5663
```shell
5764
git remote add upstream https://github.com/coderabbitai/coderabbit-docs.git
5865
git fetch upstream
@@ -64,4 +71,4 @@ git rebase upstream/main
6471
- Work on**one issue at a time** to avoid confusion.
6572
- If you need help, post in the`#support` channel on Discord.
6673
- Test your changes locally before submitting a PR.
67-
- While AI is cool, minimize its use for`direct teamcommunication`. We value concise, genuine exchanges over scripted messages.
74+
- While AI is cool, minimize its use for_direct teamcommunication_. We value concise, genuine exchanges over scripted messages.

‎README.md‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
1212
[![Twitter Follow](https://img.shields.io/twitter/follow/coderabbitai?style=social)](https://twitter.com/coderabbitai)
1313
[![Discord](https://img.shields.io/discord/invite-code?color=7289DA&label=Discord&logo=discord&logoColor=green)](https://discord.com/invite/GsXnASn26c)
1414
[![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)
1516

1617
##About CodeRabbit
1718

@@ -155,28 +156,28 @@ CodeRabbit uses the following order of precedence for configuration:
155156

156157
1. Clone this repository:
157158

158-
```bash
159-
git clone https://github.com/coderabbit-ai/coderabbit-docs.git
160-
cd coderabbit-docs
161-
```
159+
```sh
160+
git clone https://github.com/coderabbit-ai/coderabbit-docs.git
161+
cd coderabbit-docs
162+
```
162163

163164
2. Install dependencies:
164165

165-
```bash
166-
pnpm install
167-
```
166+
```sh
167+
pnpm install
168+
```
168169

169170
3. Start the development server:
170171

171-
```bash
172-
pnpm start
173-
```
172+
```sh
173+
pnpm start
174+
```
174175

175-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
176+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
176177

177178
## Project Structure
178179

179-
```
180+
```sh
180181
coderabbit-docs/
181182
├── blog/
182183
├── docs/
@@ -192,15 +193,15 @@ coderabbit-docs/
192193

193194
## Local Development
194195

195-
```
196+
```sh
196197
docusaurus start
197198
```
198199

199200
This command starts a local development server and opens up a browser window.
200201

201202
## Building for Production
202203

203-
```
204+
```sh
204205
docusaurus build
205206
```
206207

‎docs/Future Development.md‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,60 +4,60 @@ sidebar_label: Future Development
44
description:Learn how CodeRabbit works in a pull request review.
55
---
66

7-
#Future Developments
7+
#Future Developments
88

99
We are actively iterating and refining CodeRabbit, and this is a sneak peek into the upcoming milestones and releases. We are focused on making the Applied AI review better than the median manual review. In addition to that, we are looking at a holistic user experience with various integrations and types of reviews.
1010

11-
##Applied AI Improvements
11+
##Applied AI Improvements
1212

13-
We are actively trying to make the application of Generative AI more useful , relevant , meaningful for the coder and reviewer journey. Our immediate focus is
13+
We are actively trying to make the application of Generative AI more useful , relevant , meaningful for the coder and reviewer journey. Our immediate focus is
1414

15-
###Accuracy and Conciseness Enhancements
15+
###Accuracy and Conciseness Enhancements
1616

17-
-Refining knowledge base context understanding
18-
-Implementing advanced summarization techniques
19-
-Implementing a knowledge base feature library
17+
- Refining knowledge base context understanding
18+
- Implementing advanced summarization techniques
19+
- Implementing a knowledge base feature library
2020

2121
###Learning Refinements
2222

23-
-We have made significant improvement of the learning Enhancing reinforcement learning based on the user feedback
23+
- We have made significant improvement of the learning Enhancing reinforcement learning based on the user feedback
2424

25-
##New Feature Enhancements
25+
##New Feature Enhancements
2626

27-
###Expanded Integrations
27+
###Expanded Integrations
2828

2929
We are integrating various tool chains to enable coders and reviewers to have a consistent experience irrespective of the tools. The immediate tools would be:
3030

31-
-**Circle CI**
32-
-**Jenkins**
31+
-**Circle CI**
32+
-**Jenkins**
3333

34-
###Communication Tool Integrations
34+
###Communication Tool Integrations
3535

3636
Communication and the user experience of review via various communication tools are going to be key. We will start with integrations to Slack and Microsoft Teams and will be diving into the design engineering of these flows further:
3737

38-
-**Slack**: Real-time notifications and interactive discussions
39-
-**Microsoft Teams**: Code review conversations within Microsoft ecosystem
38+
-**Slack**: Real-time notifications and interactive discussions
39+
-**Microsoft Teams**: Code review conversations within Microsoft ecosystem
4040

41-
###Enhanced Review Capabilities
41+
###Enhanced Review Capabilities
4242

4343
These are additional capabilities that can also be reviewed in the same PR to accelerate the coder and reviewer journey. This includes pipeline failure analysis and resolution, as well as vulnerability assessment.
4444

45-
####Pipeline Failure Analysis
45+
####Pipeline Failure Analysis
4646

4747
- Automated analysis of CI/CD pipeline failures
4848
- AI-driven suggestions for resolving issues
4949
- Historical tracking of pipeline performance
5050

51-
###Finishing Touches
51+
###Finishing Touches
5252

5353
Finishing touches are about experience that often take developers time away from what they like doing best - coding. But adding finishing touches is crucial and should follow the ontology and taxonomy. We will start by looking into Docstring and expand to various areas to solve pain points for coders and reviewers.
5454

5555
####1. DocString Review
5656

57-
-Automated checks for docstring presence and quality
58-
-AI-powered suggestions for improving documentation
59-
-Resolving Doc-string conflicts in a following PR
57+
- Automated checks for docstring presence and quality
58+
- AI-powered suggestions for improving documentation
59+
- Resolving Doc-string conflicts in a following PR
6060

61-
>Disclaimer: any product roadmap features mentioned below are only meant to outline
62-
>our general product direction. This documentation is for informational purposes
61+
>Disclaimer: any product roadmap features mentioned below are only meant to outline
62+
>our general product direction. This documentation is for informational purposes
6363
>only and may not be incorporated into any contract.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp