Define a Trigger File
Identify files in your repository that should trigger a reminder when updated,
such as src/**/*.js.
Define a Reminder File
Specify the files that need updates when trigger files change, like
README.md.
Set Up the Message
Create a message to be sent when a reminder is triggered, e.g., "Don't forget to update the README."
Visit the Clarity Reminder GitHub App page and install the app to your repository. It's super easy! 😊
Add a configuration file named .clarity/config.yaml to your repository with
the following structure:
# Configuration for Clarity Reminder
version: 1.0
reminders:
- name: Update README & RELEASE_NOTES
on_update:
- src/**/*.js
- lib/**/*
remind_me:
- README.md
- RELEASE_NOTES.md
message: "Don't forget to update the README & RELEASE NOTES file with the latest changes."
- name: Documentation Update
on_update:
- src/api/*
remind_me:
- docs/*
message: "Documentation needs to be updated with the latest changes."
Modify the .clarity/config.yaml file to add or update reminders as needed. Follow
the pattern examples provided in the configuration file. Simple as that! 👍
For more information on using paths, you can refer to this tutorial: Wildcard Paths Tutorial
Commit and push the configuration file to your repository. The Clarity Reminder app will start working automatically on new pull requests. 🎉
🌟 What Our Users Say
game-changer for our team
"We never miss updating our documentation now, and it ensures our codebase remains well-documented and organized."
Jane D., Software Engineer
seamless integration with GitHub
"The easy configuration makes Clarity Reminder a must-have for any development workflow. It's saved us countless hours and improved our project management."
Mike L., DevOps Specialist
always thorough and complete
"The automatic reminders are a simple yet effective way to ensure nothing gets overlooked."
Sarah K., Project Manager
taken the hassle out
"of keeping our README and CHANGELOG up to date. The setup was straightforward, and it started working immediately. Highly recommend it!"
Tom R., Backend Developer
unobtrusive it is
"It does its job perfectly without getting in the way, and the automated comments are super helpful."
Lisa M., Frontend Developer
improved our testing workflow
"Clarity Reminder ensures that all necessary files are updated, making our testing process much smoother and more efficient."
Alex P., QA Engineer
👀 What's next?
📁 Multi-Repository Support
Track and remind changes across multiple repositories for a more comprehensive workflow.
🔗 Graph-based Dependency Tracking
Track dependencies between files and automatically update reminders based on changes.
🚀 Want more? Let us know!
Got a cool idea for a feature? Let us know and we'll see if we can add it to our roadmap!
👋 Stay Connected!
Hi! I'm Patrick from The Base Company. Have feedback or want to read more?