GitXplorerGitXplorer
a

weekly-digest

public
248 stars
30 forks
43 issues

Commits

List of commits on branch master.
Verified
ad544deb86e0c9570a10309a958f8b7fe3c8b6d6

Merge pull request #84 from probot/fix_deprecation_warning

aabhijeetps committed 5 years ago
Unverified
846a808b40da134283fc6303b073c4504ab24940

:art: Fix more tests to improve coverage

aabhijeetps committed 5 years ago
Unverified
1ad5ca8b81dc68d04899889da1e43febfb8da967

:art: Fix deprecation warning

aabhijeetps committed 5 years ago
Verified
bbea8b0066a24dc5e102c921a146c6a47dbbbdeb

Merge pull request #83 from probot/jest_config

aabhijeetps committed 5 years ago
Unverified
58b7b8009fdde3eca9e6ee9abddbf916a5c2be77

:fire: Remove test coverage

aabhijeetps committed 5 years ago
Unverified
4e7a4ea5b2115988974dedf1eb96382b9fb4d741

:pencil: Update style

aabhijeetps committed 5 years ago

README

The README file for this repository.

Weekly Digest

App built using Probot which generates a weekly automated summary of activities and happening on your GitHub repository.

Weekly Digest Logo

Installs Uptime Robot status Build Status

App in Action

A Weekly Digest generated by app.

Installation

  1. Explore Weekly Digest app here: GitHub Apps - Weekly Digest
  2. Now, click install and confim your installation location.
  3. Your app is ready and is live, visit your repository to check out the weekly digest the app has published!

Features

When the Weekly Digest App gets installed in a repository of a user or organization, it curates together the following data and publishes it as an issue:

  • Issues created in the last one week
    • Open Issues
    • Closed Issues
    • Noisy Issue
    • Liked Issue
  • Pull requests opened, updated, or merged in the last pull request
    • Opened Pull Requests
    • Updated Pull Requests
    • Merged Pull Requests
  • Commits made in the master branch, in the last week
  • Contributors, adding contributions in the last week
  • Stargazers, or the fans of your repositories, who really loved your repo
  • Releases, of the project you are working on

The app, as the name suggests, generates these digests and publishes it on weekly basis, typically on a Sunday.

One can change the default configuration of the app by adding a .github/weekly-digest.yml file in their GitHub repository, which allows them to configure the publication day and the specific information included in the digest.

How to Contribute

  1. Fork this repository.
  2. Clone the forked repository on your development machine.
  3. Move into your project's directory: cd weekly-digest
  4. Run npm install to setup the project.
  5. Follow Configuring a GitHub App too configure your app on your development machine.
  6. Follow Running the app locally to run your app on your development machine.
  7. Before you add a feature or suggest some changes, we recommend opening an issue here so that we can have a discussion about the changes.
  8. Please make sure you run npm test before submitting a pull request. If possible, please add tests for your changes also.

Code Style

The app is using Javascript Standard Style for linting.

Test Framework

The app is using Jest for Javascript testing.

Credits

This project is developed and maintained by Abhijeet Singh.

It is one of the Google Summer of Code 2018 Projects.

Click here to view this Project "Weekly Digest" on Google Summer of Code 2018 Projects

I would like to thanks Gregor Martynus and Wilhelm Klopp for being really awesome mentors and guiding me for this project. ❤️