(incubator-devlake) branch main updated: Add some comments for github pr collector (#7705)

[ab...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

abeizn pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git


The following commit(s) were added to refs/heads/main by this push:
     new 6d96f06ca Add some comments for github pr collector (#7705)
6d96f06ca is described below

commit 6d96f06ca791b89357e53a0d448c59bf8b679c6b
Author: Lynwee <li...@merico.dev>
AuthorDate: Mon Jul 8 17:17:34 2024 +0800

    Add some comments for github pr collector (#7705)
    
    * fix(zentao): make sure close_date must be before opened_date
    
    * docs(github): add some comments
---
 backend/plugins/github/tasks/pr_collector.go | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/backend/plugins/github/tasks/pr_collector.go b/backend/plugins/github/tasks/pr_collector.go
index cc6d31e3a..a2687cd1c 100644
--- a/backend/plugins/github/tasks/pr_collector.go
+++ b/backend/plugins/github/tasks/pr_collector.go
@@ -57,8 +57,10 @@ type SimpleGithubApiPr struct {
 	CreatedAt time.Time `json:"created_at"`
 }
 
+// CollectApiPullRequests collects pull requests.
+// FIXME There may be a related issues: https://github.com/apache/incubator-devlake/issues/7704
 func CollectApiPullRequests(taskCtx plugin.SubTaskContext) errors.Error {
-	// pull requests are Finalizable, they can't be re-open once closed
+	// pull requests are finalizable, they can't be re-opened once closed
 	data := taskCtx.GetData().(*GithubTaskData)
 	db := taskCtx.GetDal()