As you may know, I've been writing periodic "Repo Recaps" for the work getting put into DEV by our team and contributing community members. The recaps are a quick summary of what is getting merged and shipped in our project. Transparency is great, but if our process is hidden away in commits and pull requests without context or curation, it's not reaching as many people as it could.
Since creating this recap was growing ever-more time-consuming, I began automating it. And now we are officially open-sourcing the script I created!
The Repo Recap Writer is a simple command line tool to help you write an automated summary of the latest pull requests and issues in your repository. It generates Markdown to be copy and pasted, and you can use that Markdown to publish a new post on dev.to.
🚧 This is currently still a work in progress! 🚧
There's a lot of general purposing work to be done. This originally started as a bit of a side project, and most of it is built with hard-coded solutions. Since this was made by me (Andy Zhao) to automate my own workflow, you can also consider me the maintainer of this project.
This tool is essentially a command line tool/script, meant to be run locally. To get up and running:
- Clone the repository.
- Create two files in the folder:
environment.rb: This is where you store…
The script included is still very much related to my personal process, but we think by opening this up we could extend this for re-use on other projects and add functionality that automates more of this in more clever ways.
Any pull requests or issues are welcome in terms of cleaning code, pitching UX improvements, adding functionality, etc.
Thanks a lot, and happy coding!
Single Responsibility Principle (or SRP) is one of the most important concepts in software development. The main idea of this concept is: all pieces of software must have only a single responsibility.