Info for new Guard maintainers
Thanks for being interested in maintaining Guard!
First, both Guard and Listen are sometimes a bit complex at places - and both are used by many users, so I'd suggest finding a way of helping you enjoy.
You can also decide how involved you want to be - from just helping users with casual problems, to development towards Guard 3.x
Status
Both Guard and Listen are very stable and quite robust right now - issues are rarely reported, so it's a good time for development.
Ideas to you can start with:
- Every now and then, check the Guard Google Group and StackOverflow #Guard tag for reported problems and create issues for them in GitHub here (I track only GitHub issues, so if people have problems in the group, I probably won't know because I rarely check).
- Mention me (@e2) in GitHub whenever there's a tough problem related to Guard or Listen (I track most Guard plugins, so I usually get messages)
- Watch the projects Guard, Listen and any other Guard plugins you use frequently (I have access to many, so I can often quickly release a fixed version)
- Skim through the Wiki sections in Guard and Listen - most problems users have are either known or have workarounds.
- Simplify and improve documentation wherever you can (the less, the simpler, the better)
- Go through open issues (in Guard, Listen or any plugins you're interested in) and see if there's anything you'd like to work on (I'm not actively working on any, so they are all up for grabs)
- You can go through the code and TODOs to refactor/improve
- If you want to actively develop anything towards Guard 3x or if you have ideas - just open an issue and I'll help as much as I can.
So check if there's something you'd like doing, create some pull requests, I'll help you get them merged and then you can decide if you liked the experience.
If your contributions show you clearly know your way around (just enough to avoid breaking things for users), I'd be happy to give you maintainer/owner access.
Intro
Installation
- System Notifications
- Terminal Colors on Windows
- Add Readline support to Ruby on Mac OS X
- Which Growl library should I use
- Efficient Filesystem Handling
Getting Started
- List of Guard Commands
- Command Line Options for Guard
- List of available Guards
- Guardfile examples
- Run Guard within RubyMine
- Guardfile-DSL / Configuring-Guard
- Configuration Files
- Interacting with Guard
- Guard Signals
Troubleshooting
Advanced use of Guard
Cookbooks
Development
This wiki and the Guard README document contains a lot of information, please take your time and read these instructions carefully.
If you run into any trouble, you may start by understanding how Guard works.
We provide detailed changes for each Guard release.
Be sure to read the CONTRIBUTING guidelines before reporting a new Guard issue or open a pull request.
If you have any questions about the Guard usage or want to share some information with the Guard community, please go to one of the following places:
- Google+ community
- Google group
- StackOverflow
- IRC channel
#guard
(irc.freenode.net) for chatting