| 
									
										
										
										
											2016-05-03 14:23:42 +01:00
										 |  |  |  | # Maintainers: Avoiding Burnout
 | 
					
						
							| 
									
										
										
										
											2017-01-04 16:16:00 -06:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-05-03 14:23:42 +01:00
										 |  |  |  | **This guide is for maintainers.** These special people have **write | 
					
						
							|  |  |  |  | access** to Homebrew’s repository and help merge the contributions of | 
					
						
							|  |  |  |  | others. You may find what is written here interesting, but it’s | 
					
						
							|  |  |  |  | definitely not for everyone. | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-18 17:45:12 -04:00
										 |  |  |  | ## 1. Use Homebrew
 | 
					
						
							| 
									
										
										
										
											2016-05-03 14:23:42 +01:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  | Maintainers of Homebrew should be using it regularly. This is partly because | 
					
						
							|  |  |  |  | you won't be a good maintainer unless you can put yourself in the shoes of our | 
					
						
							| 
									
										
										
										
											2017-03-18 17:45:12 -04:00
										 |  |  |  | users, but also because you may decide to stop using Homebrew and at that point | 
					
						
							| 
									
										
										
										
											2016-05-03 14:23:42 +01:00
										 |  |  |  | you should also decide not to be a maintainer and find other things to work on. | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-18 17:45:12 -04:00
										 |  |  |  | ## 2. No Guilt About Leaving
 | 
					
						
							| 
									
										
										
										
											2016-05-03 14:23:42 +01:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  | All maintainers can stop working on Homebrew at any time without any guilt or | 
					
						
							| 
									
										
										
										
											2018-09-06 15:07:00 +01:00
										 |  |  |  | explanation (like leaving a job). We may still ask for your help with questions | 
					
						
							|  |  |  |  | after you leave but you are under no obligation to answer them. Like a job, if | 
					
						
							|  |  |  |  | you create a big mess and then leave you still have no obligations but we may | 
					
						
							|  |  |  |  | think less of you (or, realistically, probably just revert the problematic | 
					
						
							|  |  |  |  | work). Like a job, you should probably take a break from Homebrew at least a few | 
					
						
							|  |  |  |  | times a year. | 
					
						
							| 
									
										
										
										
											2016-05-03 14:23:42 +01:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  | This also means contributors should be consumers. If an owner finds they are | 
					
						
							| 
									
										
										
										
											2017-03-18 17:45:12 -04:00
										 |  |  |  | not using a project in the real world, they should reconsider their involvement | 
					
						
							| 
									
										
										
										
											2016-05-03 14:23:42 +01:00
										 |  |  |  | with the project. | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-18 17:45:12 -04:00
										 |  |  |  | ## 3. Prioritise Maintainers Over Users
 | 
					
						
							| 
									
										
										
										
											2016-05-03 14:23:42 +01:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  | It's important to be user-focused but ultimately, as long as you follow #1 | 
					
						
							|  |  |  |  | above, Homebrew's minimum number of users will be the number of maintainers. | 
					
						
							|  |  |  |  | However, if Homebrew has no maintainers it will quickly become useless to all | 
					
						
							|  |  |  |  | users and the project will die. As a result, no user complaint, behaviour or | 
					
						
							|  |  |  |  | need takes priority over the burnout of maintainers. If users do not like the | 
					
						
							|  |  |  |  | direction of the project, the easiest way to influence it is to make | 
					
						
							|  |  |  |  | significant, high-quality code contributions and become a maintainer. | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-18 17:45:12 -04:00
										 |  |  |  | ## 4. Learn To Say No
 | 
					
						
							| 
									
										
										
										
											2016-05-03 14:23:42 +01:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  | Homebrew gets a lot of feature requests, non-reproducible bug reports, usage | 
					
						
							|  |  |  |  | questions and PRs we won't accept. These should be closed out as soon as we | 
					
						
							|  |  |  |  | realise that they aren't going to be resolved or merged. This is kinder than | 
					
						
							|  |  |  |  | deciding this after a long period of review. Our issue tracker should reflect | 
					
						
							|  |  |  |  | work to be done. | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-12-04 16:55:17 +00:00
										 |  |  |  | ## 5. Slow Down
 | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | We're a volunteer-run open source project used by a lot of people. That can mean | 
					
						
							|  |  |  |  | that it feels like there's a lot of pressure to get a fix, package or project | 
					
						
							|  |  |  |  | completed ASAP. Try to not feel this pressure; slow down, focus on Homebrew | 
					
						
							|  |  |  |  | being enjoyable. If in doubt: over-communicate your decision making. A revert | 
					
						
							|  |  |  |  | can always be done now and a proper fix done tomorrow. | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-05-03 14:23:42 +01:00
										 |  |  |  | --- | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-11-19 17:06:01 -05:00
										 |  |  |  | _Thanks to <https://gist.github.com/ryanflorence/124070e7c4b3839d4573> which influenced this document._ |