OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-06-16 11:28:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update contributing.mdx

Browse Source
This commit is contained in:
Timothy Jaeryang Baek 2024-11-12 19:37:46 -08:00
parent f302ab1490
commit 81fbbc8115
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/contributing.mdx
View File

@ -26,9 +26,10 @@ We welcome pull requests. Before submitting one, please:
### 🛠 Code PR Best Practices: ### 🛠 Code PR Best Practices:
1. **Follow Existing Code Convention:** Ensure your code aligns with the existing coding standards and practices of the project. 1. **Atomic PRs:** Make sure your PRs are small, focused, and deal with a single objective or task. This helps in easier code review and limits the chances of introducing unrelated issues. If the scope of changes grows too large, consider breaking them into smaller, logically independent PRs.
2. **Avoid Additional External Dependencies:** Do not include additional external dependencies without prior discussion. 2. **Follow Existing Code Convention:** Ensure your code aligns with the existing coding standards and practices of the project.
3. **Framework Agnostic Approach:** We aim to stay framework agnostic. Implement functionalities on our own whenever possible rather than relying on external frameworks or libraries. If you have doubts or suggestions regarding this approach, feel free to discuss it. 3. **Avoid Additional External Dependencies:** Do not include additional external dependencies without prior discussion.
4. **Framework Agnostic Approach:** We aim to stay framework agnostic. Implement functionalities on our own whenever possible rather than relying on external frameworks or libraries. If you have doubts or suggestions regarding this approach, feel free to discuss it.
Thank you for contributing! 🚀 Thank you for contributing! 🚀