kopia lustrzana https://github.com/Yakifo/amqtt
				
				
				
			add contributing.md and .pre-commit-config.yaml
							rodzic
							
								
									b72a389e6c
								
							
						
					
					
						commit
						2c1b425820
					
				|  | @ -104,3 +104,6 @@ ENV/ | |||
| 
 | ||||
| # Project specific | ||||
| tests/plugins/test.db | ||||
| 
 | ||||
| # pycharm | ||||
| .idea/ | ||||
|  |  | |||
|  | @ -0,0 +1,18 @@ | |||
| fail_fast: false | ||||
| files: ^(tests|hbmqtt|samples)/ | ||||
| repos: | ||||
| - repo: local | ||||
|   hooks: | ||||
|   - id: flake8 | ||||
|     name: flake8 | ||||
|     entry: flake8 | ||||
|     language: system | ||||
|     args: ["--ignore=E501,W503,W605,E722"] | ||||
|     types: [python] | ||||
| 
 | ||||
|   - id: black | ||||
|     name: Black | ||||
|     entry: black | ||||
|     args: [--check] | ||||
|     language: system | ||||
|     types: [python] | ||||
|  | @ -0,0 +1,14 @@ | |||
| # Contributing to AMQTT | ||||
| 
 | ||||
| :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: | ||||
| 
 | ||||
| The following is a set of guidelines for contributing to AMQTT on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||||
| 
 | ||||
| ## Testing | ||||
| 
 | ||||
| When adding a new feature please add a test along with the feature. The testing coverage should not decrease. | ||||
| If you encounter a bug when using AMQTT which you then resolve, please reproduce the issue in a test as well. | ||||
| 
 | ||||
| ## Style and linting | ||||
| 
 | ||||
| We use `black` at default settings along with `flake8`. To avoid repeated pushes to satisfy our CI linter, you can use [pre-commit](https://pre-commit.com). Install the necessary hooks with `pre-commit install`. | ||||
		Ładowanie…
	
		Reference in New Issue
	
	 Marius Kriegerowski
						Marius Kriegerowski