2021-08-18 10:47:35 -07:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								# How to Contribute
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-08-18 19:30:55 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								Welcome to [OpenMetadata ](https://open-metadata.org ). Our goal is to build an Open standard for Metadata. We genuinely believe this mission can only be achieved through building a great community.
							 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:47:35 -07:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								We ❤️ all contributions, big and small!
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								## Github issues
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-11-13 23:03:20 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								Look for issues under [Github/issues tab ](https://github.com/open-metadata/OpenMetadata/issues ). If you have a feature request or found a bug please file an issue. This will help us track and will help the community overall as well.
							 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:47:35 -07:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2022-03-10 08:59:13 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:47:35 -07:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								## Fork Github project
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-11-13 23:03:20 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								OpenMetadata Github repository can be accessed here [https://github.com/open-metadata/OpenMetadata ](https://github.com/open-metadata/OpenMetadata ).
							 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:47:35 -07:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2022-03-10 08:59:13 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								.png>)
							 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:47:35 -07:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-08-19 13:08:12 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								Create a local clone of your fork
							 
						 
					
						
							
								
									
										
										
										
											2021-08-20 14:14:14 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```bash
							 
						 
					
						
							
								
									
										
										
										
											2021-08-19 13:08:12 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								git clone https://github.com/< username > /OpenMetadata.git
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```
							 
						 
					
						
							
								
									
										
										
										
											2021-08-20 14:14:14 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-11-13 23:03:20 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								Set a new remote repository that points to the OpenMetadata repository to pull changes from the open-source OpenMetadata codebase into your clone
							 
						 
					
						
							
								
									
										
										
										
											2021-08-20 14:14:14 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-08-19 13:08:12 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								```bash
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								cd OpenMetadata/
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								git remote add upstream https://github.com/open-metadata/OpenMetadata.git
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								git remote -v
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```
							 
						 
					
						
							
								
									
										
										
										
											2021-08-20 14:14:14 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:47:35 -07:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								## Create a branch in your fork
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```bash
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								git checkout -b ISSUE-200
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2022-03-22 15:33:07 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								Make changes. Follow the [Coding Style ](https://github.com/open-metadata/OpenMetadata/blob/main/docs/open-source-community/developer/docs/open-source-community/developer/backend/coding-style.md ) Guide on best practices and [Build the code & run tests ](build-code-run-tests/ ) on how to set up IntelliJ, Maven.
							 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:47:35 -07:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								## Push your changes to Github
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```bash
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								git add .
							 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:56:46 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								git commit -m "ISSUE-200: Meaningful commit message"
							 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:47:35 -07:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								git push origin HEAD:refs/heads/issue-200
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								## Open a PR
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:55:24 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								1.  Go to [https://github.com/open-metadata/OpenMetadata/pulls ](https://github.com/open-metadata/OpenMetadata/pulls ) 
						 
					
						
							
								
									
										
										
										
											2022-03-10 08:59:13 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								2.  It should show an option to open a pull request.  
						 
					
						
							
								
									
										
										
										
											2021-10-15 03:51:13 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								3.   If not, click on "New Pull request" 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:47:35 -07:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2022-03-10 08:59:13 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								    
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								4.  Select your fork repository and branch  
						 
					
						
							
								
									
										
										
										
											2021-08-18 19:30:55 +00:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								5.  Click "Create pull request" 
						 
					
						
							
								
									
										
										
										
											2021-08-18 10:47:35 -07:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								## We are here to help
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2021-10-15 03:51:13 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								Please reach out to us anytime you need any help. [Slack ](https://slack.open-metadata.org ) would be fastest way to get a response.