Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 3.02 KB
Raw

Contributing to Airbyte Quickstarts

Thank you for considering contributing to Airbyte Quickstarts! 🌟 It’s people like you that make this project valuable for the community. Whether it’s fixing bugs or adding new Quickstarts, we welcome your contributions.

How Can I Contribute?

1. Reporting Bugs

  • First, check the Issues to see if the bug has already been reported.
  • If it hasn’t, open a new issue, providing a descriptive title and a clear description.

2. Suggesting Enhancements

  • Before suggesting enhancements, please read the documentation and check the Issues to see if it has been discussed before.
  • If it hasn’t, open a new issue, providing a descriptive title, detailed description, and use case.

3. Submitting Changes and New Quickstarts

  1. Fork the Repository: Create your own fork of the quickstarts repository.
  2. Clone the Repository: Clone your forked repository to your local machine. 
    git clone https://github.com/your-username/quickstarts.git
  3. Create a Branch: Create a new branch from main for your changes. 
    git checkout -b feature/my-new-feature
  4. Make Changes: Make your changes or additions to the new branch.
  5. Commit Changes: Commit your changes with a clear and descriptive commit message. 
    git commit -m "Add a new quickstart"
  6. Push Changes: Push your changes to your fork on GitHub. 
    git push origin feature/my-new-feature
  7. Submit a Pull Request: Go to the Pull Requests of the original repository and create a new pull request. Provide a clear description of the changes and reference any related issues.

4. Notes for New Quickstarts

  1. Create it in a New Directory: Each Quickstart should live in its own directory and be a standalone project.
  2. Add a README.md: All Quickstarts should have clear and detailed instructions about how to set them up.

Style Guides

  • Write clean and simple code, following the existing code structure and naming conventions.
  • For Markdown files, adhere to Markdown Guide.
  • Include comments with clear explanations of your code.
  • Update the documentation (README.md) if needed, to reflect the changes made.

Review Process

Once your pull request is submitted, maintainers will review it. They may ask for additional changes or clarifications. Once the pull request is approved, it will be merged into the main branch.

Contact

For questions or help with the contributing process, please reach out in the #hackathons channel in the Airbyte Slack.

Thank you for contributing to Airbyte Quickstarts! 🚀