You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/docs/contribute/introduction.md
+5-28Lines changed: 5 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,53 +18,39 @@ Need guidance? Join our [Discord community](https://discord.gg/9uXCAwqQZW) where
18
18
We welcome and appreciate any form of contributions:
19
19
20
20
### 🐛 Bug Reports
21
+
21
22
- Report parsing errors or incorrect linting behavior
22
23
- Share performance issues or regressions
23
24
- Document edge cases we haven't considered
24
25
25
26
### 🚀 Feature Development
27
+
26
28
- Add new linting rules
27
29
- Improve parser conformance
28
30
- Enhance transformer capabilities
29
31
- Build new tools in the Oxc ecosystem
30
32
31
33
### 📚 Documentation
34
+
32
35
- Improve getting started guides
33
36
- Add examples and tutorials
34
37
- Document architecture decisions
35
38
- Translate content to other languages
36
39
37
40
### 🧪 Testing
41
+
38
42
- Add test cases from real-world codebases
39
43
- Improve test coverage
40
44
- Create performance benchmarks
41
45
- Test against ecosystem projects
42
46
43
47
### 🔧 Infrastructure
48
+
44
49
- Improve build and CI systems
45
50
- Enhance development tooling
46
51
- Optimize performance critical paths
47
52
- Maintain compatibility with other tools
48
53
49
-
## Getting Started
50
-
51
-
### Development Environment
52
-
53
-
1.**Install Rust**: Follow the [official Rust installation guide](https://rustup.rs/)
54
-
2.**Clone the Repository**:
55
-
```bash
56
-
git clone https://github.com/oxc-project/oxc
57
-
cd oxc
58
-
```
59
-
3.**Build the Project**:
60
-
```bash
61
-
cargo build
62
-
```
63
-
4.**Run Tests**:
64
-
```bash
65
-
cargo test
66
-
```
67
-
68
54
### Understanding the Codebase
69
55
70
56
Oxc is organized into several crates:
@@ -74,7 +60,6 @@ Oxc is organized into several crates:
74
60
-**`oxc_transformer`**: TypeScript and JSX transformation
75
61
-**`oxc_minifier`**: JavaScript minification (in development)
76
62
-**`oxc_formatter`**: Code formatting (in development)
77
-
-**`oxc_resolver`**: Module resolution
78
63
79
64
### Your First Contribution
80
65
@@ -96,14 +81,6 @@ Oxc is organized into several crates:
96
81
97
82
We are committed to providing a welcoming and inclusive experience for everyone. Please read our [Code of Conduct](https://github.com/oxc-project/oxc/blob/main/CODE_OF_CONDUCT.md) before participating.
98
83
99
-
### Recognition
100
-
101
-
We appreciate all contributions! Contributors are:
102
-
- Listed in our release notes
103
-
- Added to our [contributors page](https://github.com/oxc-project/oxc/graphs/contributors)
104
-
- Eligible for Oxc contributor swag
105
-
- Invited to join our private contributor Discord channels
106
-
107
84
## Next Steps
108
85
109
86
Ready to contribute? Here are some great places to start:
0 commit comments