mirror of
				https://github.com/docker/setup-buildx-action.git
				synced 2025-11-01 01:40:11 +08:00 
			
		
		
		
	Add bug report template
Add CONTRIBUTING and SUPPORT guidelines Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
This commit is contained in:
		
							parent
							
								
									52d3d47639
								
							
						
					
					
						commit
						715e105e28
					
				
							
								
								
									
										29
									
								
								.github/CONTRIBUTING.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								.github/CONTRIBUTING.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,29 @@ | |||||||
|  | ## Contributing | ||||||
|  | 
 | ||||||
|  | Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. | ||||||
|  | 
 | ||||||
|  | Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE). | ||||||
|  | 
 | ||||||
|  | ## Submitting a pull request | ||||||
|  | 
 | ||||||
|  | 1. [Fork](https://github.com/docker/setup-buildx-action/fork) and clone the repository | ||||||
|  | 2. Configure and install the dependencies: `yarn install` | ||||||
|  | 3. Make sure the tests pass on your machine: `yarn run test` | ||||||
|  | 4. Create a new branch: `git checkout -b my-branch-name` | ||||||
|  | 5. Make your change, add tests, and make sure the tests still pass | ||||||
|  | 6. Run pre-checkin: `yarn run pre-checkin` | ||||||
|  | 7. Push to your fork and [submit a pull request](https://github.com/docker/setup-buildx-action/compare) | ||||||
|  | 8. Pat your self on the back and wait for your pull request to be reviewed and merged. | ||||||
|  | 
 | ||||||
|  | Here are a few things you can do that will increase the likelihood of your pull request being accepted: | ||||||
|  | 
 | ||||||
|  | - Make sure the `README.md` and any other relevant **documentation are kept up-to-date**. | ||||||
|  | - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option. | ||||||
|  | - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as **separate pull requests**. | ||||||
|  | - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||||||
|  | 
 | ||||||
|  | ## Resources | ||||||
|  | 
 | ||||||
|  | - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) | ||||||
|  | - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) | ||||||
|  | - [GitHub Help](https://help.github.com) | ||||||
							
								
								
									
										33
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										33
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,33 @@ | |||||||
|  | --- | ||||||
|  | name: Bug report | ||||||
|  | about: Create a report to help us improve | ||||||
|  | --- | ||||||
|  | 
 | ||||||
|  | ### Behaviour | ||||||
|  | 
 | ||||||
|  | #### Steps to reproduce this issue | ||||||
|  | 
 | ||||||
|  | 1. | ||||||
|  | 2. | ||||||
|  | 3. | ||||||
|  | 
 | ||||||
|  | #### Expected behaviour | ||||||
|  | 
 | ||||||
|  | > Tell us what should happen | ||||||
|  | 
 | ||||||
|  | #### Actual behaviour | ||||||
|  | 
 | ||||||
|  | > Tell us what happens instead | ||||||
|  | 
 | ||||||
|  | ### Configuration | ||||||
|  | 
 | ||||||
|  | * Repository URL (if public):  | ||||||
|  | * Build URL (if public):  | ||||||
|  | 
 | ||||||
|  | ```yml | ||||||
|  | # paste your YAML workflow file here and remove sensitive data | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | ### Logs | ||||||
|  | 
 | ||||||
|  | > Download the [log file of your build](https://help.github.com/en/actions/configuring-and-managing-workflows/managing-a-workflow-run#downloading-logs) and [attach it](https://help.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests) to this issue. | ||||||
							
								
								
									
										31
									
								
								.github/SUPPORT.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										31
									
								
								.github/SUPPORT.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,31 @@ | |||||||
|  | # Support [](https://isitmaintained.com/project/docker/setup-buildx-action) | ||||||
|  | 
 | ||||||
|  | First, [be a good guy](https://github.com/kossnocorp/etiquette/blob/master/README.md). | ||||||
|  | 
 | ||||||
|  | ## Reporting an issue | ||||||
|  | 
 | ||||||
|  | Please do a search in [open issues](https://github.com/docker/setup-buildx-action/issues?utf8=%E2%9C%93&q=) to see if the issue or feature request has already been filed. | ||||||
|  | 
 | ||||||
|  | If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment. | ||||||
|  | 
 | ||||||
|  | :+1: - upvote | ||||||
|  | 
 | ||||||
|  | :-1: - downvote | ||||||
|  | 
 | ||||||
|  | If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below. | ||||||
|  | 
 | ||||||
|  | ## Writing good bug reports and feature requests | ||||||
|  | 
 | ||||||
|  | File a single issue per problem and feature request. | ||||||
|  | 
 | ||||||
|  | * Do not enumerate multiple bugs or feature requests in the same issue. | ||||||
|  | * Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes. | ||||||
|  | 
 | ||||||
|  | The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. | ||||||
|  | 
 | ||||||
|  | You are now ready to [create a new issue](https://github.com/docker/setup-buildx-action/issues/new/choose)! | ||||||
|  | 
 | ||||||
|  | ## Closure policy | ||||||
|  | 
 | ||||||
|  | * Issues that don't have the information requested above (when applicable) will be closed immediately and the poster directed to the support guidelines. | ||||||
|  | * Issues that go a week without a response from original poster are subject to closure at our discretion. | ||||||
		Loading…
	
		Reference in New Issue
	
	Block a user
	 CrazyMax
						CrazyMax