Skip to content

Conversation

@Dhairya3124
Copy link

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:

  • Project Setup: The new starter kit includes a basic setup for the framework.
  • Connection to Couchbase: The starter kit can establish a connection to either Couchbase Server and Couchbase Capella.
  • Environment Variables: The .env.sample file has been added with the necessary environment variables, following the template provided in the samples directory.
  • Deployment Configurations: Gitpod and GitHub Codespaces configurations are provided for easy setup.
  • Testing: A GitHub Action workflow is included to test the connection to Couchbase.
  • Documentation: A README.md file is included with setup instructions.
  • 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) |

Additional Notes:

  • Please review the Contributing Guide README to ensure your project meets all the required criteria.
  • Once your pull request is approved, your project will be officially added to the Couchbase community starter kits!

@Dhairya3124
Copy link
Author

@hummusonrails This PR is ready for your review!
Thanks
Dhairya

@hummusonrails
Copy link
Collaborator

Thanks, @Dhairya3124! I'm tagging in my colleagues @ldoguin and @shivaylamba to help with the PR review.

@Dhairya3124
Copy link
Author

Hey @hummusonrails Any update on this PR?

@hummusonrails
Copy link
Collaborator

Pinging @shivaylamba to take a look. 🔔

@shivay-couchbase
Copy link

Hey @Dhairya3124 sure I will take a look at this shortly
Thanks for the reminder @hummusonrails

Copy link

@shivay-couchbase shivay-couchbase left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the first iteration of the Golang starter kit.

Here are some high level comments:

  1. Currently the main.go file has code that references to the travel sample dataset.
    in Line 41 you have the code:
	cluster, err := gocb.Connect("couchbases://"+connectionString, options)

So either you can remove the "couchbases:// string from the code and allow the user to paste the entire connection string from the environment variable or mention this in the Github Readme.

  1. Regarding the Github Workflow, please try to run that workflow and see if you are able to successfully run the action and update it to checkout Golang instead of the default Java.

  2. In the README you have mentioned:

cd URL

This needs to be changed

  1. In the tests, create an actual test for one of the endpoints (could be the connection endpoint)

@Dhairya3124
Copy link
Author

@shivay-couchbase Thanks for your review! I'll update accordingly and make changes.

@shivay-couchbase
Copy link

Hi @Dhairya3124 any updates since last time?

@Dhairya3124
Copy link
Author

Hey @shivay-couchbase I will try to complete it by this weekend.

@Dhairya3124
Copy link
Author

Hey @shivay-couchbase I have completed all the tasks now. Can you please give a quick review?

Thanks

@Dhairya3124
Copy link
Author

Hey @shivay-couchbase Any changes required on this PR?

@shivaylamba
Copy link

Hi @Dhairya3124 my apologies for the delay, I will check back on this PR this week and get back to you

@Dhairya3124
Copy link
Author

Hey @shivay-couchbase Any other changes required from my side?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants