mirror of
				https://github.com/juanfont/headscale.git
				synced 2025-11-03 17:41:03 +01:00 
			
		
		
		
	Add readme note about codestyle
This commit is contained in:
		
							parent
							
								
									f94b0b54d8
								
							
						
					
					
						commit
						e8726b1e22
					
				
							
								
								
									
										17
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										17
									
								
								README.md
									
									
									
									
									
								
							@ -63,6 +63,23 @@ Please have a look at the documentation under [`docs/`](docs/).
 | 
			
		||||
 | 
			
		||||
To contribute to Headscale you would need the lastest version of [Go](https://golang.org) and [Buf](https://buf.build)(Protobuf generator).
 | 
			
		||||
 | 
			
		||||
### Code style
 | 
			
		||||
 | 
			
		||||
To ensure we have some consistency with a growing number of contributes, this project has adopted linting and style/formatting rules:
 | 
			
		||||
 | 
			
		||||
The **Go** code is linted with [`golangci-lint`](https://golangci-lint.run) and 
 | 
			
		||||
formatted with [`golines`](https://github.com/segmentio/golines) (width 88) and 
 | 
			
		||||
[`gofumpt`](https://github.com/mvdan/gofumpt).
 | 
			
		||||
Please configure your editor to run the tools while developing and make sure to 
 | 
			
		||||
run `make lint` and `make fmt` before committing any code.
 | 
			
		||||
 | 
			
		||||
The **Proto** code is linted with [`buf`](https://docs.buf.build/lint/overview) and 
 | 
			
		||||
formatted with [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html).
 | 
			
		||||
 | 
			
		||||
The **rest** (markdown, yaml, etc) is formatted with [`prettier`](https://prettier.io).
 | 
			
		||||
 | 
			
		||||
Check out the `.golangci.yaml` and `Makefile` to see the specific configuration.
 | 
			
		||||
 | 
			
		||||
### Install development tools
 | 
			
		||||
 | 
			
		||||
- Go
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user