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: .devcontainer/README.md
+7-2Lines changed: 7 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,35 +1,40 @@
1
1
# Development with devcontainer
2
+
2
3
This project includes a devcontainer configuration that allows you to open the project in a container with a fully configured development environment.
3
4
Both frontend and backend environments are initialized when the container is started.
5
+
4
6
## GitHub Codespaces
7
+
5
8
[](https://codespaces.new/langgenius/dify)
6
9
7
10
you can simply click the button above to open this project in GitHub Codespaces.
8
11
9
12
For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace).
10
13
11
-
12
14
## VS Code Dev Containers
15
+
13
16
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/langgenius/dify)
14
17
15
18
if you have VS Code installed, you can click the button above to open this project in VS Code Dev Containers.
16
19
17
20
You can learn more in the [Dev Containers documentation](https://code.visualstudio.com/docs/devcontainers/containers).
18
21
19
-
20
22
## Pros of Devcontainer
23
+
21
24
Unified Development Environment: By using devcontainers, you can ensure that all developers are developing in the same environment, reducing the occurrence of "it works on my machine" type of issues.
22
25
23
26
Quick Start: New developers can set up their development environment in a few simple steps, without spending a lot of time on environment configuration.
24
27
25
28
Isolation: Devcontainers isolate your project from your host operating system, reducing the chance of OS updates or other application installations impacting the development environment.
26
29
27
30
## Cons of Devcontainer
31
+
28
32
Learning Curve: For developers unfamiliar with Docker and VS Code, using devcontainers may be somewhat complex.
29
33
30
34
Performance Impact: While usually minimal, programs running inside a devcontainer may be slightly slower than those running directly on the host.
31
35
32
36
## Troubleshooting
37
+
33
38
if you see such error message when you open this project in codespaces:
Copy file name to clipboardExpand all lines: .github/CODE_OF_CONDUCT.md
+10-12Lines changed: 10 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,27 +17,25 @@ diverse, inclusive, and healthy community.
17
17
Examples of behavior that contributes to a positive environment for our
18
18
community include:
19
19
20
-
* Demonstrating empathy and kindness toward other people
21
-
* Being respectful of differing opinions, viewpoints, and experiences
22
-
* Giving and gracefully accepting constructive feedback
23
-
* Accepting responsibility and apologizing to those affected by our mistakes,
20
+
- Demonstrating empathy and kindness toward other people
21
+
- Being respectful of differing opinions, viewpoints, and experiences
22
+
- Giving and gracefully accepting constructive feedback
23
+
- Accepting responsibility and apologizing to those affected by our mistakes,
24
24
and learning from the experience
25
-
* Focusing on what is best not just for us as individuals, but for the
25
+
- Focusing on what is best not just for us as individuals, but for the
26
26
overall community
27
27
28
28
Examples of unacceptable behavior include:
29
29
30
-
* The use of sexualized language or imagery, and sexual attention or
30
+
- The use of sexualized language or imagery, and sexual attention or
31
31
advances of any kind
32
-
* Trolling, insulting or derogatory comments, and personal or political attacks
33
-
* Public or private harassment
34
-
* Publishing others' private information, such as a physical or email
32
+
- Trolling, insulting or derogatory comments, and personal or political attacks
33
+
- Public or private harassment
34
+
- Publishing others' private information, such as a physical or email
35
35
address, without their explicit permission
36
-
* Other conduct which could reasonably be considered inappropriate in a
36
+
- Other conduct which could reasonably be considered inappropriate in a
37
37
professional setting
38
38
39
39
## Language Policy
40
40
41
41
To facilitate clear and effective communication, all discussions, comments, documentation, and pull requests in this project should be conducted in English. This ensures that all contributors can participate and collaborate effectively.
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
> [!IMPORTANT]
2
2
>
3
3
> 1. Make sure you have read our [contribution guidelines](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md)
4
-
> 2. Ensure there is an associated issue and you have been assigned to it
5
-
> 3. Use the correct syntax to link this PR: `Fixes #<issue number>`.
4
+
> 1. Ensure there is an associated issue and you have been assigned to it
5
+
> 1. Use the correct syntax to link this PR: `Fixes #<issue number>`.
Copy file name to clipboardExpand all lines: CLAUDE.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
7
7
Dify is an open-source platform for developing LLM applications with an intuitive interface combining agentic AI workflows, RAG pipelines, agent capabilities, and model management.
8
8
9
9
The codebase consists of:
10
+
10
11
-**Backend API** (`/api`): Python Flask application with Domain-Driven Design architecture
11
12
-**Frontend Web** (`/web`): Next.js 15 application with TypeScript and React 19
| High-Priority Features as being labeled by a team member | High Priority |
58
-
| Popular feature requests from our [community feedback board](https://github.com/langgenius/dify/discussions/categories/feedbacks)| Medium Priority |
59
-
| Non-core features and minor enhancements | Low Priority |
| High-Priority Features as being labeled by a team member | High Priority |
58
+
| Popular feature requests from our [community feedback board](https://github.com/langgenius/dify/discussions/categories/feedbacks)| Medium Priority |
59
+
| Non-core features and minor enhancements | Low Priority |
60
+
| Valuable but not immediate | Future-Feature |
61
+
61
62
## Submitting your PR
62
63
63
64
### Pull Request Process
64
65
65
66
1. Fork the repository
66
-
2. Before you draft a PR, please create an issue to discuss the changes you want to make
67
-
3. Create a new branch for your changes
68
-
4. Please add tests for your changes accordingly
69
-
5. Ensure your code passes the existing tests
70
-
6. Please link the issue in the PR description, `fixes #<issue_number>`
71
-
7. Get merged!
67
+
1. Before you draft a PR, please create an issue to discuss the changes you want to make
68
+
1. Create a new branch for your changes
69
+
1. Please add tests for your changes accordingly
70
+
1. Ensure your code passes the existing tests
71
+
1. Please link the issue in the PR description, `fixes #<issue_number>`
72
+
1. Get merged!
73
+
72
74
### Setup the project
73
75
74
76
#### Frontend
@@ -82,12 +84,14 @@ For setting up the backend service, kindly refer to our detailed [instructions](
82
84
#### Other things to note
83
85
84
86
We recommend reviewing this document carefully before proceeding with the setup, as it contains essential information about:
87
+
85
88
- Prerequisites and dependencies
86
89
- Installation steps
87
90
- Configuration details
88
91
- Common troubleshooting tips
89
92
90
93
Feel free to reach out if you encounter any issues during the setup process.
94
+
91
95
## Getting Help
92
96
93
97
If you ever get stuck or get a burning question while contributing, simply shoot your queries our way via the related GitHub issue, or hop onto our [Discord](https://discord.gg/8Tpq4AcN9c) for a quick chat.
| Hochprioritäre Features (durch Teammitglied gekennzeichnet) | Hohe Priorität |
56
+
| Beliebte Feature-Anfragen aus unserem [Community-Feedback-Board](https://github.com/langgenius/dify/discussions/categories/feedbacks)| Mittlere Priorität |
57
+
| Nicht-Kernfunktionen und kleinere Verbesserungen | Niedrige Priorität |
58
+
| Wertvoll, aber nicht dringend | Zukunfts-Feature |
59
59
60
60
## Einreichen Ihres PRs
61
61
62
62
### Pull-Request-Prozess
63
63
64
64
1. Repository forken
65
-
2. Vor dem Erstellen eines PRs bitte ein Issue zur Diskussion der Änderungen erstellen
66
-
3. Einen neuen Branch für Ihre Änderungen erstellen
67
-
4. Tests für Ihre Änderungen hinzufügen
68
-
5. Sicherstellen, dass Ihr Code die bestehenden Tests besteht
69
-
6. Issue in der PR-Beschreibung verlinken (`fixes #<issue_number>`)
70
-
7. Auf den Merge warten!
65
+
1. Vor dem Erstellen eines PRs bitte ein Issue zur Diskussion der Änderungen erstellen
66
+
1. Einen neuen Branch für Ihre Änderungen erstellen
67
+
1. Tests für Ihre Änderungen hinzufügen
68
+
1. Sicherstellen, dass Ihr Code die bestehenden Tests besteht
69
+
1. Issue in der PR-Beschreibung verlinken (`fixes #<issue_number>`)
70
+
1. Auf den Merge warten!
71
71
72
72
### Projekt einrichten
73
73
@@ -82,6 +82,7 @@ Für die Einrichtung des Backend-Service folgen Sie bitte unseren detaillierten
82
82
#### Weitere Hinweise
83
83
84
84
Wir empfehlen, dieses Dokument sorgfältig zu lesen, da es wichtige Informationen enthält über:
85
+
85
86
- Voraussetzungen und Abhängigkeiten
86
87
- Installationsschritte
87
88
- Konfigurationsdetails
@@ -92,4 +93,3 @@ Bei Problemen während der Einrichtung können Sie sich gerne an uns wenden.
92
93
## Hilfe bekommen
93
94
94
95
Wenn Sie beim Mitwirken Fragen haben oder nicht weiterkommen, stellen Sie Ihre Fragen einfach im entsprechenden GitHub Issue oder besuchen Sie unseren [Discord](https://discord.gg/8Tpq4AcN9c) für einen schnellen Austausch.
0 commit comments