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
Welcome every user and developer in the community to become contributors. Whether it's reporting issues, improving
4
-
documentation, submitting code, or providing technical support, your participation will help make the Apache Fesod (
5
-
Incubating) better.
6
3
7
-
---
4
+
Welcome every user and developer in the community to become contributors. Whether it's reporting issues, improving documentation, submitting code, or providing technical support, your participation will help make it better.
8
5
9
6
## Contribution Directions
10
7
11
-
There are many ways to contribute to Apache Fesod (Incubating):
8
+
There are many ways to contribute to this project:
12
9
13
10
- Fix typos
14
11
- Fix bugs
@@ -19,237 +16,57 @@ There are many ways to contribute to Apache Fesod (Incubating):
19
16
- Optimize code structure
20
17
- Improve or refine documentation
21
18
22
-
**Principle**:
19
+
### Principle
23
20
24
21
- Any pull request that contributes to the improvement of the project should be encouraged.
25
-
- Before contributing a new feature, please propose and discuss it in an `issue` or `discussion`. We will not merge
26
-
features that have not been discussed and confirmed.
22
+
- Before contributing a new feature, please propose and discuss it in an `issue` or `discussion`. We will not merge features that have not been discussed and confirmed.
27
23
28
-
---
24
+
## Contribution Process
29
25
30
-
##Contributing Code
26
+
### Find tasks
31
27
32
-
All improvements can be implemented through Pull Request (PR). Before submitting a Pull Request, please familiarise
33
-
yourself with the following guidelines:
28
+
Find the issue you are interested in! On our GitHub repo issue list, we often publish some issues with the label `good first issue` or `help wanted`. These issues welcome the help of contributors. Among them, `good first issues` tend to have low thresholds and are suitable for beginners.
34
29
35
-
### Workspace Preparation
30
+
Of course, if you have a good idea, you can also propose it directly on GitHub Discussion or contact with community.
36
31
37
-
To develop Apache Fesod (Incubating), you need **Maven 3.9 or above** and **JDK (Java Development Kit) 17 or above**.
38
-
However, you must
39
-
use **Java 1.8** compatible language features during compilation to ensure Apache Fesod (Incubating) can run in
40
-
environments with Java
41
-
1.8 or above.
32
+
### Discuss
42
33
43
-
> You can use tools such as [SDKMAN](https://sdkman.io/) to configure multiple versions of the Java toolchain.
34
+
Please refer to [Issue Feedback](https://fesod.apache.org/community/feedback/) to create an issue or discussion and endeavour to reach consensus.
44
35
45
-
### Fork the repository
36
+
**Note**: To request an issue, please note that it is not just a "please assign it to me", you need to explain your understanding of the issue, and your design, and if possible, you need to provide your POC code.
46
37
47
-
Ensure that you have registered a GitHub account and follow the steps below to configure your local development
48
-
environment:
38
+
### Implement
49
39
50
-
**Fork the repository**: Click the `Fork` button on the Apache Fesod (
51
-
Incubating) [GitHub page](https://github.com/apache/fesod) to copy the project to your GitHub account.
40
+
Implement the change according to the approach agreed upon in the issue.
52
41
53
-
```bash
54
-
https://github.com/<your-username>/fesod
55
-
```
42
+
- Only start working on the implementation if there is consensus on the approach (e.g. you are assigned to the ticket)
43
+
- If you are newer, can refer to [Code Contribution](https://fesod.apache.org/community/contribution/contribute-code/) to setup a dev environment.
56
44
57
-
**Clone Repository**: Run the following command to clone the forked project to your local machine:
All improvements can be implemented through Pull Request (PR). Before submitting a Pull Request.
61
+
Please refer to [Code Contribution](https://fesod.apache.org/community/contribution/contribute-code/) for information on how to contribute code.
128
62
129
63
## Contribution of Test Cases
130
64
131
-
Any contribution of test cases is encouraged, especially unit tests. It is recommended to create `XXXTest.java` files in
132
-
the corresponding module's `test` directory, preferably using the `JUnit5` framework.
133
-
134
-
---
65
+
Any contribution of test cases is encouraged, especially unit tests. It is recommended to create `XXXTest.java` files in the corresponding module's `test` directory, preferably using the `JUnit5` framework.
135
66
136
67
## Contribution Document
137
68
138
-
Documentation is an important component of the Apache Fesod (Incubating) official website and serves as a vital bridge
139
-
between the
140
-
project and the community.The Apache Fesod (Incubating) official website is built
141
-
using [Docusaurus](https://docusaurus.io/), and the
142
-
documentation is maintained in the [website](https://github.com/apache/fesod/tree/main/website) directory.
143
-
144
-
### Requirements
145
-
146
-
-[Node.js](https://nodejs.org/en/download/) version 18.0 or above (which can be checked by running `node -v`). You can
147
-
use [nvm](https://github.com/nvm-sh/nvm) for managing multiple Node versions on a single machine installed.
148
-
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
149
-
150
-
### Directory Structure Description
151
-
152
-
Docusaurus supports I18n. The main documentation directory structure that needs to be maintained is as follows:
153
-
154
-
```bash
155
-
.
156
-
├── community # Community(English)
157
-
├── docs # Documentation(English)
158
-
└── i18n # I18n
159
-
└── zh-cn
160
-
├── docusaurus-plugin-content-docs
161
-
│ └── current # Documentation(Simplified Chinese)
162
-
└── docusaurus-plugin-content-docs-community
163
-
└── current # Community(Simplified Chinese)
164
-
```
165
-
166
-
The directory structure for single-language documents is as follows:
167
-
168
-
```bash
169
-
.
170
-
├── quickstart # 1. Quick Start
171
-
├── read# 2. Read
172
-
├── write # 3. Write
173
-
├── fill # 4. Fill
174
-
├── community # 5. Community
175
-
└── help# 6. FAQ
176
-
```
177
-
178
-
### Documentation Writing Guidelines
179
-
180
-
- Use file paths with the `.md` extension
181
-
182
-
```markdown
183
-
[Example](docs/quickstart/example.md)
184
-
```
185
-
186
-
- Use paths relative to the docs/ directory
187
-
188
-
```markdown
189
-
[Example](docs/quickstart/example.md)
190
-
```
191
-
192
-
- Image files must be stored in the `static/img` directory and referenced using relative directory paths.
193
-
194
-
```markdown
195
-
[img](/img/docs/fill/listFill_file.png)
196
-
```
197
-
198
-
### Preview and generate static files
199
-
200
-
Enter the `website` directory and execute the command
201
-
202
-
#### Installation
203
-
204
-
```bash
205
-
yarn install
206
-
```
207
-
208
-
#### Local Development
209
-
210
-
```bash
211
-
# English
212
-
yarn start
213
-
214
-
# Simplified Chinese
215
-
yarn start --locale zh-cn
216
-
```
217
-
218
-
This command starts a local development server and opens up a browser window. Most changes are reflected live without
219
-
having to restart the server.
220
-
221
-
> Only one language version can be run at a time.
222
-
223
-
#### Build(Optional)
224
-
225
-
```bash
226
-
yarn build
227
-
```
228
-
229
-
This command generates static content into the `build` directory and can be served using any static contents hosting
230
-
service.
231
-
232
-
### Document Format Inspection
233
-
234
-
Apache Fesod (Incubating) uses [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) to check document
235
-
formatting. After writing the relevant Markdown articles, you can run the following command locally to pre-check whether
236
-
the Markdown formatting meets the requirements:
237
-
238
-
```bash
239
-
cd website && yarn
240
-
241
-
yarn md-lint
242
-
243
-
# If the documentation is wrong, you can use the following command to attempt an automatic repair.
244
-
yarn md-lint-fix
245
-
```
246
-
247
-
- For formatting rules for Markdown articles you can refer
248
-
to: [Markdown-lint-rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md)
Documentation is an important component of the project official website and serves as a vital bridge between the project and the community. Please refer to [Docs Contribution](https://fesod.apache.org/community/contribution/contribute-doc/) for information on how to contribute code.
253
70
254
71
## Other Ways to Contribute
255
72
@@ -258,20 +75,5 @@ Apart from directly contributing code, the following ways are also valuable supp
258
75
- Answering other users' questions.
259
76
- Assisting in reviewing others' PRs.
260
77
- Providing improvement suggestions.
261
-
- Writing technical blogs to promote.
78
+
- Writing technical blogs to promote Apache Fesod (Incubating).
262
79
- Sharing project-related knowledge in the community.
263
-
264
-
---
265
-
266
-
## Code Style
267
-
268
-
Apache Fesod (Incubating) uses [Spotless](https://github.com/diffplug/spotless) as its code formatting tool. Please
269
-
ensure you run the following command to automatically format your code before submitting:
270
-
271
-
```bash
272
-
mvn spotless:apply
273
-
```
274
-
275
-
---
276
-
277
-
Finally, thank you for your support of Apache Fesod (Incubating)!
Copy file name to clipboardExpand all lines: website/community/contribution.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ Of course, if you have a good idea, you can also propose it directly on GitHub D
33
33
34
34
### Discuss
35
35
36
-
Please refer to [Issue Feedback](../feedback.md) to create an issue or discussion and endeavour to reach consensus.
36
+
Please refer to [Issue Feedback](./feedback.md) to create an issue or discussion and endeavour to reach consensus.
37
37
38
38
**Note**: To request an issue, please note that it is not just a "please assign it to me", you need to explain your understanding of the issue, and your design, and if possible, you need to provide your POC code.
39
39
@@ -42,7 +42,7 @@ Please refer to [Issue Feedback](../feedback.md) to create an issue or discussio
42
42
Implement the change according to the approach agreed upon in the issue.
43
43
44
44
- Only start working on the implementation if there is consensus on the approach (e.g. you are assigned to the ticket)
45
-
- If you are newer, can refer to [Code Contribution](./contribute-code.md) to setup a dev environment.
45
+
- If you are newer, can refer to [Code Contribution](./contribution/contribute-code.md) to setup a dev environment.
46
46
47
47
### Review
48
48
@@ -59,15 +59,16 @@ Create the pull request and work with the reviewer.
59
59
60
60
## Contribution Code
61
61
62
-
All improvements can be implemented through Pull Request (PR). Before submitting a Pull Request, please refer to [Code Contribution](./contribute-code.md) to setup a dev environment.
62
+
All improvements can be implemented through Pull Request (PR). Before submitting a Pull Request.
63
+
Please refer to [Code Contribution](./contribution/contribute-code.md) for information on how to contribute code.
63
64
64
65
## Contribution of Test Cases
65
66
66
67
Any contribution of test cases is encouraged, especially unit tests. It is recommended to create `XXXTest.java` files in the corresponding module's `test` directory, preferably using the `JUnit5` framework.
67
68
68
69
## Contribution Document
69
70
70
-
Documentation is an important component of the project official website and serves as a vital bridge between the project and the community.The project official website is built using [Docusaurus](https://docusaurus.io/), and the documentation is maintained in the [website](https://github.com/apache/fesod/tree/main/website) directory.
71
+
Documentation is an important component of the project official website and serves as a vital bridge between the project and the community. Please refer to [Docs Contribution](./contribution/contribute-code.md) for information on how to contribute document.
0 commit comments