doc(dev): add remarks about creating good commits (messages)
preview (don't bookmark): https://return42.github.io/searx/dev/contribution_guide.html#code Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
		
							parent
							
								
									5eb8cf4ebb
								
							
						
					
					
						commit
						4ca8b69c81
					
				| @ -50,6 +50,16 @@ Code | |||||||
| ==== | ==== | ||||||
| 
 | 
 | ||||||
| .. _PEP8: https://www.python.org/dev/peps/pep-0008/ | .. _PEP8: https://www.python.org/dev/peps/pep-0008/ | ||||||
|  | .. _Conventional Commits: https://www.conventionalcommits.org/ | ||||||
|  | .. _Git Commit Good Practice: https://wiki.openstack.org/wiki/GitCommitMessages | ||||||
|  | .. _Structural split of changes: | ||||||
|  |     https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes | ||||||
|  | 
 | ||||||
|  | .. sidebar:: Create good commits! | ||||||
|  | 
 | ||||||
|  |    - `Structural split of changes`_ | ||||||
|  |    - `Conventional Commits`_ | ||||||
|  |    - `Git Commit Good Practice`_ | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| In order to submit a patch, please follow the steps below: | In order to submit a patch, please follow the steps below: | ||||||
| @ -59,6 +69,9 @@ In order to submit a patch, please follow the steps below: | |||||||
|   - PEP8_ standards apply, except the convention of line length |   - PEP8_ standards apply, except the convention of line length | ||||||
|   - Maximum line length is 120 characters |   - Maximum line length is 120 characters | ||||||
| 
 | 
 | ||||||
|  | - The cardinal rule for creating good commits is to ensure there is only one | ||||||
|  |   *logical change* per commit / read `Structural split of changes`_ | ||||||
|  | 
 | ||||||
| - Check if your code breaks existing tests.  If so, update the tests or fix your | - Check if your code breaks existing tests.  If so, update the tests or fix your | ||||||
|   code. |   code. | ||||||
| 
 | 
 | ||||||
| @ -66,6 +79,16 @@ In order to submit a patch, please follow the steps below: | |||||||
| 
 | 
 | ||||||
| - Add yourself to the :origin:`AUTHORS.rst` file. | - Add yourself to the :origin:`AUTHORS.rst` file. | ||||||
| 
 | 
 | ||||||
|  | - Choose meaning full commit messages, read `Conventional Commits`_ | ||||||
|  | 
 | ||||||
|  |   .. code:: | ||||||
|  | 
 | ||||||
|  |      <type>[optional scope]: <description> | ||||||
|  | 
 | ||||||
|  |      [optional body] | ||||||
|  | 
 | ||||||
|  |      [optional footer(s)] | ||||||
|  | 
 | ||||||
| - Create a pull request. | - Create a pull request. | ||||||
| 
 | 
 | ||||||
| For more help on getting started with searx development, see :ref:`devquickstart`. | For more help on getting started with searx development, see :ref:`devquickstart`. | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user
	 Markus Heiser
						Markus Heiser