Interested in contributing a starter kit for Couchbase in your favorite language and/or framework? Start here by exploring the open Issues and reading the guide on how to get started.
Pull Request Template for New Couchbase Starter Kit Projects
Related Issue:
Please link to the issue your new project addresses:
Issue: #3
Checklist:
Before submitting your pull request, ensure the following items have been completed:
[x] Project Setup: The new starter kit includes a basic setup for the framework.
[x] Connection to Couchbase: The starter kit can establish a connection to either Couchbase Server and Couchbase Capella.
[x] Environment Variables: The .env.sample file has been added with the necessary environment variables, following the template provided in the samples directory.
[x] Deployment Configurations: Gitpod and GitHub Codespaces configurations are provided for easy setup.
[x] Testing: A GitHub Action workflow is included to test the connection to Couchbase.
[x] Documentation: A README.md file is included with setup instructions.
[x] Community Starter Kit Table: A link to the new starter kit has been added to the "Community Starter Kits" section of the Contributing Guide README.
New Project Link:
Please provide the link to your new starter kit in the "Community Starter Kits" section of the contributing guide.
Add the details of your new starter kit to the table below in the following format:
| Framework Name | [Framework Starter Kit](URL_TO_YOUR_PROJECT) |
Pull Request Template for New Couchbase Starter Kit Projects
Related Issue:
Please link to the issue your new project addresses:
Checklist:
Before submitting your pull request, ensure the following items have been completed:
.env.sample
file has been added with the necessary environment variables, following the template provided in the samples directory.README.md
file is included with setup instructions.New Project Link:
Please provide the link to your new starter kit in the "Community Starter Kits" section of the contributing guide.
Add the details of your new starter kit to the table below in the following format:
Additional Notes: