OPENGIT/stable-diffusion-webui
1
0
Fork 0
mirror of https://github.com/AUTOMATIC1111/stable-diffusion-webui.git synced 2024-12-29 19:05:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated Contributing (markdown)

AUTOMATIC1111 2023-05-18 10:21:52 +03:00
parent c2e04fedef
commit 8b8aa597d1
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Contributing.md

@ -21,7 +21,18 @@ If you're not a contributor to this repository, you need to fork and clone the r
If you are making changes to used libraries or the installation script, you must verify them to work on default Windows installation from scratch. If you cannot test if it works (due to your OS or anything else), do not make those changes (with possible exception of changes that explicitly are guarded from being executed on Windows by `if`s or something else).
# Code style
I mostly follow code style suggested by PyCharm, with the exception of disabled line length limit.
We use linters to enforce style for python and javascript. If you make a PR that fails the check, I will ask you to fix the code until the linter does not complain anymore.
Here's how to use linters locally:
#### python
Install: `pip install ruff`
Run: `ruff .` (or `python -mruff .`)
#### javascript
Install: install npm on your system.
Run: `npx eslint .`
# Quirks
* `webui.user.bat` is never to be edited