Weekly digest

[gr2m]

A bot that summarizes weekly activity in a locked issue. It would comment what issues have been mostly discussed / upvoted, new releases, welcome new contributors, give shoutouts to recurring contributors, etc

[sleepyjoker]

it's sounds interesting, could I took charge of it in the google summer of code?
I notice that there are more and more apps provide data statistics during a period, I think it is cool to have one in github.

[apoorvaagupta]

Hi @gr2m ,
I find this issue quite interesting! I and my friend @bhavya14 would love to work on it.
We have already tried our hands on probot framework and created some of our own bots.
Also, we would be trying for RGSoC under probot organisation!

We would love to create some amazing bots this summer and after it as well!!

[bhavya14]

Hi @gr2m ,
I and @apoorvaagupta are looking forward to work on this promising issue and probot in the long run !!!

[gr2m]

welcome to Probot :) Let's use this issue to ask questions about how the bot could work so you can use it for your application

[subrat-sahu]

Hey @gr2m, Can I still work on this issue?

[gr2m]

@subrat-sahu sure, just please don't share any code until after March 27th when both the Rails Girls & Google Summer of Code application deadline has passed :)

If you have any questions or would like to discuss how it could work just comment here

[subrat-sahu]

I am a GSOC'18 aspirant btw. :) .
Can you Just give me a vague idea of how should I begin with, I have read the docs and tried my hands on it.

[anshumanv]

@subrat-sahu you can go through the docs here and get started by building some basic probot apps that you like, consequently, you can check out the awesome apps that the community has built, Have fun! 😄

[svensevenslow]

Hi! I am interested in working on this idea for GSOC. I was wondering if the summary will be provided by updating the README.md file every week for the repo or do you have something else in mind? Also will it be required for all weekly digests to be stored somewhere(like in some other repo) for reference later or do you have a different view about this?

[rsarky]

Hi! I am interested in working on this idea for GSOC. I was wondering if the summary will be provided by updating the README.md file every week for the repo or do you have something else in mind?

Hey @svensevenslow . I am also working on this as a part of GSOC. The bot will basically open a locked issue where it would comment out the weekly digests.

Also will it be required for all weekly digests to be stored somewhere(like in some other repo) for reference later or do you have a different view about this?

I don't think we explicitly need to store the data somewhere as it is already available in the comments.

Hope this helped. 😃

[inishchith]

@gr2m is there any way we could get our proposal reviewed before the deadline via email / docs ? 😄

[gr2m]

yes, if you have your proposal ready, please ping me or the other mentors in our slack, in the #summer-of-code channel, we will make a private room for you and the mentors where you can share the link to your proposal (ideally a google doc that we can comment on)

[svensevenslow]

@gr2m Hi! I was wondering if I want to count the number of comments made by a user in a certain period of time in a certain repo, what would be the correct way to go about it.

[gr2m]

I’m sorry I don’t quite understand your question? I think a weekly digest could for example highlight issues that had the most activity in the past week, independent of a specific user. Does that answer your question?

[svensevenslow]

@gr2m If we need to give shoutouts to recurring contributors, won't that be user specific?

[gr2m]

ah yes, to give shout outs for recurring contributors then you want to do that. Instead of "certain repo" you can just do the repo that the app is installed on :)

[2pen]

@gr2m I am writing my proposal, i find a question. How to create a comment about the digest in a specific time automatically? For example, the robot will create a comment containing weekly digest at 00:00 on Sunday. But, in that moment, the robot can't catch any event and can't get the "context" to create comments. So does that mean it is necessary for the user to create a comment such as "Weekly Digest Please" in locked issue to trigger a event?

[gr2m]

@2pen yeah that is a tricky part :) Maybe look at how other apps are doing it that have a time-based functionality, such as https://probot.github.io/apps/stale/ or https://probot.github.io/apps/reminders/

Probot

Stale

Close stale Issues and Pull Requests

Probot

Reminders

Set reminders on Issues and Pull Requests

[anshumanv]

Use this package to trigger events on a periodic schedule. @2pen 😄

[2pen]

@gr2m @anshumanv Thanks!!

[davilaerte]

@gr2m would it be interesting to add some statistical data in the weekly summaries as: average for issues and PRs open in the week, percentage increase of stable code (that is in the master branch) in the week and other statistics that can be useful for the project and its development ?

[gr2m]

I think down the road it would be great to make it pluggable so that maintainers can configure what blocks they’d like to have in their digest

[davilaerte]

Yes @ gr2m, I think it would be nice to add summary levels so that the maintainers can choose the level they want. I also thought about adding a block that would be related to some metrics of code quality, what do you think ?

[svensevenslow]

@gr2m I just want to clarify, the idea will be to have one locked issue and the bot will make a comment on that issue every week giving the weekly summary or will the bot open a new locked issue every week to provide the summary.

[gr2m]

the idea is to have a single locked issue. I do these manually for some projects, e.g. here: https://github.com/octokit/rest.js/issues/620. The idea here is to have it fully or partly automated

[abhijeetps]

Locked Issue is a great idea.
How about creating a Wiki Entry by the bot to create weekly digests?

[rsarky]

IMO Wiki is primarily for documentation.
Also I don't think there is API support for GitHub apps to create or edit wikis? @aps120797

[abhijeetps]

Yeah, I just discussed in the Slack chat, came to know it's there is no support for GitHub apps to perform rw in Wikis.

[abhijeetps]

Hi there!
The idea has been implemented here: https://github.com/probot/weekly-digest
Here's the quick app install link: https://github.com/apps/weekly-digest

GitHub

probot/weekly-digest

weekly-digest - Weekly automated summary of activity on your GitHub repository 📆

GitHub

Build software better, together

GitHub is where people build software. More than 28 million people use GitHub to discover, fork, and contribute to over 85 million projects.