Skip to content

Commit 1ea1394

Browse files
DoragdDoragd
committed
fix readme
1 parent 10907ae commit 1ea1394

3 files changed

Lines changed: 16 additions & 11 deletions

File tree

backup/DailyLC.md renamed to DailyLC.md

File renamed without changes.

‎README.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
# 📝 Algorithm
2-
算法题练习记录博客（基于GitHub Action和GitHub Issue实现）。可通过提交issue，自动将刷题记录更新在项目的DailyLC.md中，并将issue内容备份在项目backup文件夹下。
2+
算法题练习记录博客（基于GitHub Action和GitHub Issue实现）。
3+
4+
可通过提交issue，自动将刷题记录更新在项目的DailyLC.md中，并将issue内容备份在项目backup文件夹下。
35

46
## 🎯 Usage
57
1. fork这个项目（注意激活fork后的项目的Actions, 并将项目的Settings -> issue打开）
6-
2. 每当你刷完一道算法题，可在你的项目上提交一个issue(！！issue title需要以‘R'开头，作为和真正issue的区分标识)，推荐将'R+所刷题目的标题'（比如R110.平衡二叉树）作为issue title，将题目的归属标签（比如二叉树、搜索）作为issue Labels，将你想记录的对这道题的思考作为issue的description。此时[DailyLC.md](./DailyLC.md)
8+
9+
2. 每当你刷完一道算法题，可在你的项目上提交一个issue：issue title可以是所刷题目的标题，也可以是其他任意你想记录的笔记标题。同时，你也可以为这个issue打上label，例如二叉树、搜索，将你想记录的对这道题的思考作为issue的description。[示例issue](https://github.com/Doragd/Algorithm/issues/3)
10+
11+
3. 此时[DailyLC.md]DailyLC.md)
712

813
1） Calendar部分会基于issue创建日期在日历上标记一个star
914

1015
2） Records部分会新增一行记录, 各列分别记录：
1116

1217
#: issue号
13-
Title: 截去R的issue title（点击可跳转至你所创建的issue）
18+
Title: issue title（点击可跳转至你所创建的issue）
1419
Tag： issue Labels
1520
Date: issue创建时间
1621

17-
3. 同时，backup文件夹下会以“issue号+#+截去R的issue title"作为文件名，生成一个对issue的备份文件，备份issue的description和comments
18-
4. 当你编辑issue的title或description、修改issue的Labels、issue有新comment或者issue的comment被编辑时, [DailyLC.md](./DailyLC.md)和backup文件夹下issue的备份文件都会进行相应更新(FIXME: 当issue title被改变时，会生成一个新的备份文件，但原来的备份文件并不会被删除)
22+
4. 同时，backup文件夹下会以“issue号+#+的issue title"作为文件名，生成一个对issue的备份文件，备份issue的description。该issue下所有后续的comments也会被记录下来。[示例备份文件](backup/2#110.%20平衡二叉树.md)
23+
24+
5. 当你编辑issue的title或description、修改issue的Labels、issue有新comment或者issue的comment被编辑时, [DailyLC.md](./DailyLC.md)和backup文件夹下issue的备份文件都会进行相应更新
1925

‎main.py‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ def update_records(issue, issue_number=None):
3232
if issue_number is None:
3333
issue_number = os.getenv("ISSUE_NUMBER")
3434

35-
issue_title = issue["title"][1:]
35+
issue_title = issue["title"]
3636
issue_labels = ["`" + label["name"] + "`" for label in issue["labels"]]
3737
issue_link = issue["html_url"]
3838

39-
with open("DailyLC.md", "r") as file:
39+
with open("DailyLC.md", "r+") as file:
4040
lines = file.readlines()
4141

4242
table_start_index = None
@@ -56,9 +56,8 @@ def update_records(issue, issue_number=None):
5656
else:
5757
lines.insert(table_start_index, new_line)
5858

59-
with open('DailyLC.md', 'w') as file:
59+
file.seek(0)
6060
file.writelines(lines)
61-
file.close()
6261

6362
return "Successfully updated Records of DailyLC.md"
6463

@@ -93,7 +92,7 @@ def backup_issue_as_md(issue, issue_number):
9392
if issue_number is None:
9493
issue_number = os.getenv("ISSUE_NUMBER")
9594

96-
issue_title = issue["title"][1:]
95+
issue_title = issue["title"]
9796
issue_body = issue['body']
9897
issue_labels = ["`" + label['name'] + "`" for label in issue['labels']]
9998
issue_link = issue['html_url']
@@ -125,7 +124,7 @@ def backup_issue_as_md(issue, issue_number):
125124
def main(issue_number):
126125
try:
127126
issue = get_issue(issue_number)
128-
if issue is not None and issue["title"].startswith("R"):
127+
if issue is not None:
129128
print(update_records(issue, issue_number))
130129
print(update_star(issue))
131130
print(backup_issue_as_md(issue, issue_number))

0 commit comments

Comments
 (0)