Contributing
Want to help shape OpenETL? This section walks you through why it's worth it, how to start, and how to share your work.
Why Contribute?
Your contributions make OpenETL better:
- Add adapters for new systems (e.g., Stripe, MySQL) to expand its reach.
- Fix bugs or enhance features to improve everyone's experience.
- Join a community of developers building a practical data tool.
Every line of code counts!
How to Get Started
Fork the Repo
git clone https://github.com/your-org/OpenETL.git
cd OpenETL
npm install
- Pick a Task: Check Github issues or propose a new adapter.
- Code: Build your change—see Create Adapters for adapter help.
Submitting Your Contribution
- Commit Changes:
git add .
git commit -m "Add Stripe adapter"
git push origin your-branch
- Open a Pull Request: Head to Github, create a PR, and describe your work.
- Review: Respond to feedback—collaboration makes it shine.
Tests are a bonus—check Testing Adapters.
Tips for Success
- Keep It Simple: Small, focused changes are easier to merge.
- Test Thoroughly: Ensure your code handles edge cases (e.g., rate limits).
- Follow Style: Match the repo's TypeScript conventions.
- Ask Questions: Stuck? Hit up Support for help.
Ready? Fork it and let's build something awesome together!