Commit 878b879
docs: Improve getting started and testing guides for humans and agents (#20970)
## Which issue does this PR close?
- Closes #.
## Rationale for this change
This PR is a follow-up to
#20939 from @Dandandan.
The goal is to make it easier for both humans and agents to get started
making changes in this repository and to create pull requests
efficiently.
The repository already had the necessary contributor information, but it
was spread across multiple documents and not easy to discover quickly.
## What changes are included in this PR?
This PR makes the most important setup, testing, and pre-PR checks
easier to find from the contributor guide and from `AGENTS.md`:
- Add a quick-start setup section to the contributor guide with the
shortest path to a working local environment.
- Add a testing quick-start section summarizing the most important tests
to run before submitting a PR.
- Add a “Before Submitting a PR” section to centralize formatting and
lint guidance.
- Update `AGENTS.md` to point to the canonical contributor guide
sections instead of duplicating setup and testing instructions.
## Are these changes tested?
This PR updates documentation only.
## Are there any user-facing changes?
This improves contributor-facing documentation and makes setup / testing
guidance easier to discover, but it does not change DataFusion runtime
behavior or public APIs.
---------
Co-authored-by: Yongting You <2010youy01@gmail.com>1 parent 448a395 commit 878b879
File tree
4 files changed
+94
-28
lines changed- docs/source/contributor-guide
4 files changed
+94
-28
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
5 | 8 | | |
6 | 9 | | |
7 | 10 | | |
8 | 11 | | |
9 | 12 | | |
10 | | - | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
11 | 17 | | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
| 18 | + | |
21 | 19 | | |
22 | 20 | | |
23 | 21 | | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
32 | | - | |
33 | | - | |
34 | | - | |
| 22 | + | |
| 23 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
25 | 56 | | |
26 | 57 | | |
27 | 58 | | |
| |||
34 | 65 | | |
35 | 66 | | |
36 | 67 | | |
37 | | - | |
| 68 | + | |
38 | 69 | | |
39 | 70 | | |
40 | 71 | | |
41 | 72 | | |
42 | 73 | | |
43 | 74 | | |
44 | 75 | | |
45 | | - | |
| 76 | + | |
46 | 77 | | |
47 | 78 | | |
48 | 79 | | |
49 | | - | |
| 80 | + | |
50 | 81 | | |
51 | 82 | | |
52 | 83 | | |
| |||
71 | 102 | | |
72 | 103 | | |
73 | 104 | | |
74 | | - | |
| 105 | + | |
75 | 106 | | |
76 | 107 | | |
77 | 108 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
36 | | - | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
37 | 39 | | |
38 | 40 | | |
39 | 41 | | |
| |||
99 | 101 | | |
100 | 102 | | |
101 | 103 | | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
102 | 117 | | |
103 | 118 | | |
104 | 119 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
26 | 57 | | |
27 | 58 | | |
28 | 59 | | |
| |||
0 commit comments