Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

60 lines (44 loc) · 4.12 KB

PR 新增停贷项目模板

检查

  1. 确认该项目是否已存在(检查README.md
  2. 确认该项目是否已停贷,按项目停贷类型可分为
    1. 待确认(目前暂不接受待确认停贷类型项目
    2. 待停贷(请标注)
    3. 已停贷(默认状态)
    4. 已结束(原则上只对目前已有的项目更新其是否结束的状态)
  3. 确认有该项目停贷的佐证资料,比如文字、图片、视频等,若没有相关资料,则不被接受

在确认上述条件满足的情况下,按如下规范进行提交

规范

  1. 确认项目所在的省份与城市,其命名需要符合国家三级行政标准:
    1. 若省份为直辖市,则应为"第一级/第三级",例如北京/朝阳,而非北京/北京,尽管不影响程序的正确性,但会影响理解
    2. 其他省份则应为"第一级/第二级",例如江苏/苏州,而非江苏/昆山(昆山是一个县级市),尽管不影响程序的正确性,但会影响文档结构
    3. 对于重庆/两江新区这种概念化的城市(而非行政属性)的则不被接受,程序也无法识别,您应将其修正为重庆/渝北区之类的
    4. 如果你不确定小区的具体行政信息,可以搜索一下或者参考三级行政数据
  2. 将资料存放在合适的位置
    1. 单文件规范:在 images 文件夹下找到对应的省份与城市子文件夹(如无,则手动创建),将文件存放进去,文件名最好要准确以方便理解,例如上海浦东新区君御公馆停贷通知书.png而非Xingdao_Shanghai.png
    2. 多文件规范:在 images 文件夹下找到对应的省份与城市子文件夹(如无,则手动创建),以该项目名新建一个文件夹,并加上_前缀,例如广西/桂林/_桂林融创文旅城N4地块而非广西/桂林/桂林融创文旅城N4地块,否则会引发程序读取错误
    3. 尽管目前工程里主要以图片为主,但其他格式,例如文字、语音、视频等也是支持的,但请注意如果文件很大(超过100M)则不被接受(因为需要 LFS 的支持)。原则上10M以上的文件应自行备份文件,最终以链接形式汇入。例如您可以创建一个上海/浦东新区/XX小区.md,然后在该XX小区.md里写入相关的材料引用信息
    4. 文件命名里不能有英文括号,否则无法被程序解析,中文括号可以
  3. README.md 文档里按照拼音顺序找到对应的省份和城市(如无,则手动创建),将自己的资料写入,格式规范为,~~[项目信息](项目链接)~~
    1. 逗号是为了与之前的项目分隔,如无可省略
    2. 项目信息格式为项目名称(项目状态):项目备注,其中项目状态默认为已停贷(因此可省略),您可以添加简短的项目备注,尽管目前还没有人这么做
    3. 波浪线~~表示删除,仅适用于已结束状态的项目,其他的不用加
    4. 项目链接即对应的资料位置
  4. 添加完成后,请同时修改城市合计、省份合计与全国合计,程序也会同步校验相关信息,修改正确前将不被接受

条目规范示范

1. 没有佐证资料则直接填写文字(目前已不被支持):
>>> ,某大某楼盘

2. 有一张资料则加上链接,链接指向文件:
>>> ,[某大某楼盘](某省/某市/某大某楼盘.jpg)

3. 有多张资料则加上链接,链接指向文件夹(以 _ 开头):
>>> ,[某大某楼盘](某省/某市/_某大某楼盘文件夹)

4. 有一张资料,但是项目处于待停贷状态(用中文括号标记):
>>> ,[某大某楼盘(待停贷)](某省/某市/某大某楼盘.jpg)

5. 有一张资料,希望加点备份:
>>> ,[某大某楼盘:大家快一起来看看!](某省/某市/某大某楼盘.jpg)

5. 有一张资料,已结束停贷:
>>> ,[~~某大某楼盘(已结束)~~](某省/某市/某大某楼盘.jpg)
  • 我已阅读以上规范,并确认提交新的满足要求的停贷项目