[AlgoCollector] Pull request requirement

[ledongthuc]

Source code: https://github.com/ruby-vietnam/hardcore-rule/tree/master/algorithms/collector

Background

• Algorithm collector will go through all "open" pull requests and do score calculations.

Problems

• Sometimes, "open" pull requests is not algorithm purpose. The algorithm collector counts it as a pull request of the weekly algorithm.

Proposal

• Only check pull requests that have changed files in a folder algorithm

I think I can take this issue

@ledongthuc I don't think Github API provided a list of changed files when we get PR list. To have this we need another API call per PR. I don't like this approach. Instead, we have PR's body information that might contain information we needed:

Title: "2021 - SS2 - Week4 - khoa",
Body:"- SlackAcc: khoa
- [x] Problem 1
- [x] Problem 2
- [ ] Problem 3
- [ ] Problem 4
"

For example, with a PR like above, we can make sure a PR is for algorithm submit by checking for - [x] Problem or - [ ] Problem. And I think this is enough.

What do you think?

[ro-vn]

I think we should create a convention for the Algorithm Weekly Pull request title such as [Algorithm] or [Algorithm Weekly]
i.e "[Algorithm Weekly] 2021 - SS2 - Week4 - khoa" or something like that. By using it, the PR checking will be more consistent and reliable.

That’s a good idea. What prefix should we use? [Algorithm] or [Algorithm Week]? cc @ledongthuc Sent from ProtonMail for iOS

…

On Sun, Aug 8, 2021 at 7:13 PM, Ro Ngoc Vo ***@***.***> wrote: I think we should create a convention for the Algorithm Weekly Pull request title such as [Algorithm] or [Algorithm Weekly] i.e "[Algorithm Weekly] 2021 - SS2 - Week4 - khoa" or something like that. By using it, the PR checking will be more consistent and reliable. — You are receiving this because you commented. Reply to this email directly, [view it on GitHub](#1460 (comment)), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/AVEGOHIYTAVABQGYR5L362LT342UNANCNFSM5BYGSU3Q). Triage notifications on the go with GitHub Mobile for [iOS](https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675) or [Android](https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email).

[ledongthuc]

@ZephyrOneD @ngocro208, In case Github API doesn't support changed files in API listing PRs, maybe detect patterns is a good solution. I think PR's title prefix is better than body content parsing, the [Algorithm].

But it requires everyone must follow the title convention.

Another option if we want to detect files is using a Github action that use to add labels to Pull Request bases on their file changes. Then AlgoCollector will read the PR label to detect.

https://github.com/actions/labeler

If you need to support to add the github action to test, I can do it.

Personally I think most people will easier to forgot to add a Label when they create a PR, and it's easier to do that with Title. Let's go with the Title prefix, [Algorithm Week] or [Algorithm] should both valid. Sent with [ProtonMail](https://protonmail.com/) Secure Email. ‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐

…

On Monday, August 9th, 2021 at 1:10 AM, Thuc Le ***@***.***> wrote: ***@***.***(https://github.com/zephyroned) ***@***.***(https://github.com/ngocro208), In case Github API doesn't support changed files in API listing PRs, maybe detect patterns is a good solution. I think PR's title prefix is better than body content parsing, the [Algorithm]. But it requires everyone must follow the title convention. Another option if we want to detect files is using a Github action that use to add labels to Pull Request bases on their file changes. Then AlgoCollector will read the PR label to detect. https://github.com/actions/labeler If you need to support to add the github action to test, I can do it. — You are receiving this because you were mentioned. Reply to this email directly, [view it on GitHub](#1460 (comment)), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/AVEGOHP6MZN4JDNXOMJEVW3T36EPRANCNFSM5BYGSU3Q). Triage notifications on the go with GitHub Mobile for [iOS](https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675) or [Android](https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email).

[ledongthuc]

Ok, finally, I suggest using both title prefix [Algorithm Week] or [Algorithm] or has the label "algo" (e.g. https://github.com/ruby-vietnam/hardcore-rule/pulls?q=is%3Apr+is%3Aclosed+label%3Aalgo)

[ledongthuc]

hi @huytd, I added a Github action that automatically adds the label algo with PR that changes on folder algorithms/
Feel free to use the label algo to detect file changes

[ro-vn]

Hi @ledongthuc, the labeler does not work for forks repo . I think we could apply the PR title prefix for now.