mirror of
				https://github.com/caddyserver/caddy.git
				synced 2025-11-03 19:17:29 -05:00 
			
		
		
		
	Update contributing doc and add issue template
This commit is contained in:
		
							parent
							
								
									9e386fc921
								
							
						
					
					
						commit
						f52b1e80f5
					
				@ -1,28 +1,66 @@
 | 
			
		||||
## Contributing to Caddy
 | 
			
		||||
 | 
			
		||||
**[Join our dev chat on Gitter](https://gitter.im/mholt/caddy)** to chat with
 | 
			
		||||
other Caddy developers! (Dev chat only; try our
 | 
			
		||||
[support room](https://gitter.im/caddyserver/support) for help or
 | 
			
		||||
[general](https://gitter.im/caddyserver/general) for anything else.)
 | 
			
		||||
 | 
			
		||||
This project gladly accepts contributions and we encourage interested users to 
 | 
			
		||||
get involved!
 | 
			
		||||
Welcome! Our community focuses on helping others and making Caddy the best it
 | 
			
		||||
can be. We gladly accept contributions and encourage you to get involved!
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
#### For small tweaks, bug fixes, and tests
 | 
			
		||||
### Join us in chat
 | 
			
		||||
 | 
			
		||||
Submit [pull requests](https://github.com/mholt/caddy/pulls) at any time. 
 | 
			
		||||
Bug fixes should be under test to assert correct behavior. Thank you for
 | 
			
		||||
helping out in simple ways!
 | 
			
		||||
Please direct your discussion to the correct room:
 | 
			
		||||
 | 
			
		||||
- **Dev Chat:** [gitter.im/mholt/caddy](https://gitter.im/mholt/caddy) - to chat
 | 
			
		||||
with other Caddy developers
 | 
			
		||||
- **Support:**
 | 
			
		||||
[gitter.im/caddyserver/support](https://gitter.im/caddyserver/support) - to give
 | 
			
		||||
and get help
 | 
			
		||||
- **General:**
 | 
			
		||||
[gitter.im/caddyserver/general](https://gitter.im/caddyserver/general) - for
 | 
			
		||||
anything about Web development
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
#### Ideas, questions, bug reports
 | 
			
		||||
### Bug reports
 | 
			
		||||
 | 
			
		||||
First, please [search this repository](https://github.com/mholt/caddy/search?q=&type=Issues&utf8=%E2%9C%93)
 | 
			
		||||
with a variety of keywords to ensure your bug is not already reported.
 | 
			
		||||
 | 
			
		||||
If not, [open an issue](https://github.com/mholt/caddy/issues) and answer the
 | 
			
		||||
questions so we can understand and reproduce the problematic behavior.
 | 
			
		||||
 | 
			
		||||
The burden is on you to convince us that it is actually a bug in Caddy. This is
 | 
			
		||||
easiest to do when you write clear, concise instructions so we can reproduce
 | 
			
		||||
the behavior (even if it seems obvious). The more detailed and specific you are,
 | 
			
		||||
the faster we will be able to help you. Check out
 | 
			
		||||
[How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
 | 
			
		||||
 | 
			
		||||
Please be kind. :smile: Remember that Caddy comes at no cost to you, and you're
 | 
			
		||||
getting free help. If we helped you, please consider
 | 
			
		||||
[donating](https://caddyserver.com/donate) - it keeps us motivated!
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### Minor improvements and new tests
 | 
			
		||||
 | 
			
		||||
Submit [pull requests](https://github.com/mholt/caddy/pulls) at any time. Make
 | 
			
		||||
sure to write tests to assert your change is working properly and is thoroughly
 | 
			
		||||
covered.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### Proposals, suggestions, ideas, new features
 | 
			
		||||
 | 
			
		||||
First, please [search](https://github.com/mholt/caddy/search?q=&type=Issues&utf8=%E2%9C%93)
 | 
			
		||||
with a variety of keywords to ensure your suggestion/proposal is new.
 | 
			
		||||
 | 
			
		||||
If so, you may open either an issue or a pull request for discussion and
 | 
			
		||||
feedback.
 | 
			
		||||
 | 
			
		||||
The advantage of issues is that you don't have to spend time actually
 | 
			
		||||
implementing your idea, but you should still describe it thoroughly. The
 | 
			
		||||
advantage of a pull request is that we can immediately see the impact the change
 | 
			
		||||
will have on the project, what the code will look like, and how to improve it.
 | 
			
		||||
The disadvantage of pull requests is that they are unlikely to get accepted
 | 
			
		||||
without significant changes, or it may be rejected entirely. Don't worry, that
 | 
			
		||||
won't happen without an open discussion first.
 | 
			
		||||
 | 
			
		||||
Feel free to [open an issue](https://github.com/mholt/caddy/issues) with your
 | 
			
		||||
ideas, questions, and bug reports, if one does not already exist for it. Bug
 | 
			
		||||
reports should state expected behavior and contain clear instructions for
 | 
			
		||||
isolating and reproducing the problem.
 | 
			
		||||
See [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
#### New features
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										20
									
								
								ISSUE_TEMPLATE
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										20
									
								
								ISSUE_TEMPLATE
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,20 @@
 | 
			
		||||
*If you are filing a bug report, please answer these questions. If your issue is not a bug report, you do not need to use this template. Either way, please consider donating if we've helped you. Thanks!*
 | 
			
		||||
 | 
			
		||||
#### 1. What version of Caddy are you running (`caddy -version`)?
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
#### 2. What are you trying to do?
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
#### 3. What is your entire Caddyfile?
 | 
			
		||||
```text
 | 
			
		||||
(Put Caddyfile here)
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
#### 4. How did you run Caddy (give the full command and describe the execution environment)?
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
#### 5. What did you expect to see?
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
#### 6. What did you see instead (give full error messages and/or log)?
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user