Austin/dify
1
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2024-11-16 03:32:23 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
f877d19c6a
dify/CONTRIBUTING.md
Mark Sun f877d19c6a
Update CONTRIBUTING.md (#2010)
2024-01-12 19:01:29 +08:00

2.9 KiB
Raw Blame History

Contributing

Thanks for your interest in Dify and for wanting to contribute! Before you begin, read the code of conduct and check out the existing issues. This document describes how to set up your development environment to build and test Dify.

Install dependencies

You need to install and configure the following dependencies on your machine to build Dify:

Local development

To set up a working development environment, just fork the project git repository and install the backend and frontend dependencies using the proper package manager and create run the docker-compose stack.

Fork the repository

you need to fork the repository.

Clone the repo

Clone your GitHub forked repository:

git clone git@github.com:<github_username>/dify.git

Install backend

To learn how to install the backend application, please refer to the Backend README.

Install frontend

To learn how to install the frontend application, please refer to the Frontend README.

Visit dify in your browser

Finally, you can now visit http://localhost:3000 to view the Dify in local environment.

Create a pull request

After making your changes, open a pull request (PR). Once you submit your pull request, others from the Dify team/community will review it with you.

Did you have an issue, like a merge conflict, or don't know how to open a pull request? Check out GitHub's pull request tutorial on how to resolve merge conflicts and other issues. Once your PR has been merged, you will be proudly listed as a contributor in the contributor chart.

Community channels

Stuck somewhere? Have any questions? Join the Discord Community Server. We are here to help!

Provider Integrations

If you see a model provider not yet supported by Dify that you'd like to use, follow these steps to submit a PR.

i18n (Internationalization) Support

We are looking for contributors to help with translations in other languages. If you are interested in helping, please join the Discord Community Server and let us know.
Also check out the Frontend i18n README for more information.