mirror of
https://github.com/chartdb/chartdb.git
synced 2025-10-23 07:11:56 +00:00
43 lines
1.7 KiB
Markdown
43 lines
1.7 KiB
Markdown
# **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 (support@chartdb.io) or [Discord](https://discord.gg/QeFwyWSKwC). 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).
|
||
|
||
## Questions?
|
||
|
||
Feel free to ask in `#contributing` on [Discord](https://discord.gg/QeFwyWSKwC) if you have questions about our process, how to proceed, etc.
|
||
or [Email](support@chartdb.io)
|
||
|
||
---
|
||
|
||
Thank you! 💙
|