chore: import upstream snapshot with attribution
This commit is contained in:
@@ -0,0 +1,28 @@
|
||||
# Contribution Guide
|
||||
|
||||
We welcome your contributions to this repository. To ensure elegant code style and better code quality, we have prepared the following contribution guidelines.
|
||||
|
||||
## What We Accept
|
||||
|
||||
+ This PR fixes a typo or improves the documentation (if this is the case, you may skip the other checks).
|
||||
+ This PR fixes a specific issue — please reference the issue number in the PR description. Make sure your code strictly follows the coding standards below.
|
||||
+ This PR introduces a new feature — please clearly explain the necessity and implementation of the feature. Make sure your code strictly follows the coding standards below.
|
||||
|
||||
## Code Style Guide
|
||||
|
||||
Good code style is an art. We have prepared a `pyproject.toml` and a `pre-commit` hook to enforce consistent code formatting across the project. You can clean up your code following the steps below:
|
||||
|
||||
1. Install the required dependencies:
|
||||
```shell
|
||||
pip install ruff pre-commit
|
||||
```
|
||||
2. Then, run the following command:
|
||||
```shell
|
||||
pre-commit run --all-files
|
||||
```
|
||||
If your code complies with the standards, you should not see any errors.
|
||||
|
||||
## Naming Conventions
|
||||
|
||||
- Please use **English** for naming; do not use Pinyin or other languages. All comments should also be in English.
|
||||
- Follow **PEP8** naming conventions strictly, and use underscores to separate words. Avoid meaningless names such as `a`, `b`, `c`.
|
||||
@@ -0,0 +1,51 @@
|
||||
name: "\U0001F41B Bug Report"
|
||||
description: Submit a bug report to help us improve CogVideoX / 提交一个 Bug 问题报告来帮助我们改进 CogVideoX 开源模型
|
||||
body:
|
||||
- type: textarea
|
||||
id: system-info
|
||||
attributes:
|
||||
label: System Info / 系統信息
|
||||
description: Your operating environment / 您的运行环境信息
|
||||
placeholder: Includes Cuda version, Diffusers version, Python version, operating system, hardware information (if you suspect a hardware problem)... / 包括Cuda版本,Diffusers,Python版本,操作系统,硬件信息(如果您怀疑是硬件方面的问题)...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: information-scripts-examples
|
||||
attributes:
|
||||
label: Information / 问题信息
|
||||
description: 'The problem arises when using: / 问题出现在'
|
||||
options:
|
||||
- label: "The official example scripts / 官方的示例脚本"
|
||||
- label: "My own modified scripts / 我自己修改的脚本和任务"
|
||||
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Reproduction / 复现过程
|
||||
description: |
|
||||
Please provide a code example that reproduces the problem you encountered, preferably with a minimal reproduction unit.
|
||||
If you have code snippets, error messages, stack traces, please provide them here as well.
|
||||
Please format your code correctly using code tags. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting
|
||||
Do not use screenshots, as they are difficult to read and (more importantly) do not allow others to copy and paste your code.
|
||||
|
||||
请提供能重现您遇到的问题的代码示例,最好是最小复现单元。
|
||||
如果您有代码片段、错误信息、堆栈跟踪,也请在此提供。
|
||||
请使用代码标签正确格式化您的代码。请参见 https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting
|
||||
请勿使用截图,因为截图难以阅读,而且(更重要的是)不允许他人复制粘贴您的代码。
|
||||
placeholder: |
|
||||
Steps to reproduce the behavior/复现Bug的步骤:
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Expected behavior / 期待表现
|
||||
description: "A clear and concise description of what you would expect to happen. /简单描述您期望发生的事情。"
|
||||
@@ -0,0 +1,34 @@
|
||||
name: "\U0001F680 Feature request"
|
||||
description: Submit a request for a new CogVideoX feature / 提交一个新的 CogVideoX开源模型的功能建议
|
||||
labels: [ "feature" ]
|
||||
body:
|
||||
- type: textarea
|
||||
id: feature-request
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Feature request / 功能建议
|
||||
description: |
|
||||
A brief description of the functional proposal. Links to corresponding papers and code are desirable.
|
||||
对功能建议的简述。最好提供对应的论文和代码链接。
|
||||
|
||||
- type: textarea
|
||||
id: motivation
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Motivation / 动机
|
||||
description: |
|
||||
Your motivation for making the suggestion. If that motivation is related to another GitHub issue, link to it here.
|
||||
您提出建议的动机。如果该动机与另一个 GitHub 问题有关,请在此处提供对应的链接。
|
||||
|
||||
- type: textarea
|
||||
id: contribution
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Your contribution / 您的贡献
|
||||
description: |
|
||||
|
||||
Your PR link or any other link you can help with.
|
||||
您的PR链接或者其他您能提供帮助的链接。
|
||||
Reference in New Issue
Block a user