mirror of
				https://github.com/chartdb/chartdb.git
				synced 2025-11-04 05:53:15 +00:00 
			
		
		
		
	Add CONTRIBUTING.md
This commit is contained in:
		
				
					committed by
					
						
						Jonathan Fishner
					
				
			
			
				
	
			
			
			
						parent
						
							1ff3fc3840
						
					
				
				
					commit
					a24e65894f
				
			
							
								
								
									
										43
									
								
								CONTRIBUTING.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										43
									
								
								CONTRIBUTING.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,43 @@
 | 
				
			|||||||
 | 
					# **Contributing to ChartDB**
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Thank you for your interest in contributing to ChartDB! We want to make your experience as easy as possible.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## How to Contribute
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Submitting Pull Requests
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					To submit a pull request:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Fork the repository, create a branch from `main`, and focus on a single change.
 | 
				
			||||||
 | 
					2. Write clear, concise commit messages and ensure your code follows the project's guidelines.
 | 
				
			||||||
 | 
					3. Open a pull request and clearly state what issue it addresses.
 | 
				
			||||||
 | 
					4. If needed, provide a brief explanation of your solution.
 | 
				
			||||||
 | 
					5. Submit your pull request for review.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Reporting Bugs
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					If you find a bug, check [GitHub issues](https://github.com/chartdb/chartdb/issues) to see if it’s already reported. If not, feel free to [report it](https://github.com/chartdb/chartdb/issues/new?labels=bug).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					For questions about using ChartDB, reach out to us via Email (chartdb.io@gmail.com) or [Slack](https://join.slack.com/t/chartdb/shared_invite/zt-2ourrlh5e-mKIHCRML3_~m_gHjD5EcUg). For feature requests, create a [new feature](https://github.com/chartdb/chartdb/issues/new?labels=enhancement).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Creating a Branch
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					To get started:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Fork [the repository](https://github.com/chartdb/chartdb/fork).
 | 
				
			||||||
 | 
					2. Create a branch from `main`.
 | 
				
			||||||
 | 
					3. If you’re new to GitHub pull requests, check out [this video series](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### License
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					By contributing, you agree that your work will be licensed under ChartDB's [license](https://github.com/chartdb/chartdb/blob/main/LICENSE.md).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Questions?
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Feel free to ask in `#contributing` on [Slack](https://join.slack.com/t/chartdb/shared_invite/zt-2ourrlh5e-mKIHCRML3_~m_gHjD5EcUg)  if you have questions about our process, how to proceed, etc.
 | 
				
			||||||
 | 
					or [Email](chartdb.io@gmail.com)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					---
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Thank you! 💙
 | 
				
			||||||
							
								
								
									
										16
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										16
									
								
								README.md
									
									
									
									
									
								
							@@ -9,7 +9,7 @@
 | 
				
			|||||||
</p>
 | 
					</p>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
<h3 align="center">
 | 
					<h3 align="center">
 | 
				
			||||||
  <a href="https://join.slack.com/t/chartdbcommunity/shared_invite/_1234">Community</a> |
 | 
					  <a href="https://join.slack.com/t/chartdb/shared_invite/zt-2ourrlh5e-mKIHCRML3_~m_gHjD5EcUg">Community</a> |
 | 
				
			||||||
  <a href="https://www.chartdb.io">Website</a>
 | 
					  <a href="https://www.chartdb.io">Website</a>
 | 
				
			||||||
</h3>
 | 
					</h3>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -21,9 +21,9 @@
 | 
				
			|||||||
    <img src="https://img.shields.io/badge/PRs-Welcome-brightgreen" alt="PRs welcome!" />
 | 
					    <img src="https://img.shields.io/badge/PRs-Welcome-brightgreen" alt="PRs welcome!" />
 | 
				
			||||||
  </a>
 | 
					  </a>
 | 
				
			||||||
  <a href="https://join.slack.com/t/chartdbcommunity/shared_invite/_1234">
 | 
					  <a href="https://join.slack.com/t/chartdbcommunity/shared_invite/_1234">
 | 
				
			||||||
    <img src="https://img.shields.io/badge/Join%20Slack-purple?logo=slack&link=https%3A%2F%2Fjoin.slack.com%2Ft%2Fchartdbcommunity%2Fshared_invite%2F_1234" alt="Slack community channel" />
 | 
					    <img src="https://img.shields.io/badge/Join%20Slack-purple?logo=slack&link=https://join.slack.com/t/chartdb/shared_invite/zt-2ourrlh5e-mKIHCRML3_~m_gHjD5EcUg" alt="Slack community channel" />
 | 
				
			||||||
  </a>
 | 
					  </a>
 | 
				
			||||||
  <a href="https://twitter.com/ChartDB">
 | 
					  <a href="https://x.com/chartdb_io">
 | 
				
			||||||
    <img src="https://img.shields.io/twitter/follow/ChartDB?style=social"/>
 | 
					    <img src="https://img.shields.io/twitter/follow/ChartDB?style=social"/>
 | 
				
			||||||
  </a>
 | 
					  </a>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -33,7 +33,7 @@
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
**🎉 ChartDB**:
 | 
					**🎉 ChartDB**:
 | 
				
			||||||
ChartDB is a powerful and intuitive database diagramming editor that runs as a SaaS application via a website.
 | 
					ChartDB is a powerful and intuitive database diagramming editor that runs as a SaaS application via a website.
 | 
				
			||||||
Effortlessly visualize and design your database schemas with a single **Smart Query** that fetches your entire database structure.
 | 
					Effortlessly visualize and design your database schemas with a single "**Smart Query**" that fetches your entire database structure.
 | 
				
			||||||
Customize your diagrams, export SQL scripts, and explore a full suite of features—all without the need to create an account.
 | 
					Customize your diagrams, export SQL scripts, and explore a full suite of features—all without the need to create an account.
 | 
				
			||||||
Dive into a seamless database design experience and discover the complete feature set here.
 | 
					Dive into a seamless database design experience and discover the complete feature set here.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -60,14 +60,14 @@ ChartDB is currently in Public Beta. Star and watch this repository to get notif
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## 💚 Community & Support
 | 
					## 💚 Community & Support
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- [Slack](https://chartdb.io/slack) (For live discussion with the community and the ChartDB team)
 | 
					- [Slack](https://join.slack.com/t/chartdb/shared_invite/zt-2ourrlh5e-mKIHCRML3_~m_gHjD5EcUg) (For live discussion with the community and the ChartDB team)
 | 
				
			||||||
- [GitHub Issues](https://github.com/chartdb/chartdb/issues) (For any bugs and errors you encounter using ChartDB)
 | 
					- [GitHub Issues](https://github.com/chartdb/chartdb/issues) (For any bugs and errors you encounter using ChartDB)
 | 
				
			||||||
- [Twitter](https://twitter.com/chartdb) (Get news fast)
 | 
					- [Twitter](https://x.com/chartdb_io) (Get news fast)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Contributing
 | 
					## Contributing
 | 
				
			||||||
 | 
					
 | 
				
			||||||
We welcome community contributions, big or small, and are here to guide you along
 | 
					We welcome community contributions, big or small, and are here to guide you along
 | 
				
			||||||
the way. Message us in the [ChartDB Community Slack](https://join.slack.com/t/chartdbcommunity/shared_invite/213123123213). Once you contribute, ping us in Slack and we'll send you some ChartDB swag!
 | 
					the way. Message us in the [ChartDB Community Slack](https://join.slack.com/t/chartdb/shared_invite/zt-2ourrlh5e-mKIHCRML3_~m_gHjD5EcUg). Once you contribute, ping us in Slack and we'll send you some ChartDB swag!
 | 
				
			||||||
 | 
					
 | 
				
			||||||
For more information on how to contribute, please see our
 | 
					For more information on how to contribute, please see our
 | 
				
			||||||
[Contributing Guide](/CONTRIBUTING.md).
 | 
					[Contributing Guide](/CONTRIBUTING.md).
 | 
				
			||||||
@@ -79,4 +79,4 @@ Thank you for helping us make ChartDB better for everyone :heart:.
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## License
 | 
					## License
 | 
				
			||||||
 | 
					
 | 
				
			||||||
ChartDB is licensed under the [GNU Affero General Public License v3.0](LICENSE) and as commercial software.
 | 
					ChartDB is licensed under the [GNU Affero General Public License v3.0](LICENSE)
 | 
				
			||||||
		Reference in New Issue
	
	Block a user