Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up repo #4

Conversation

corentinmusard
Copy link
Collaborator

No description provided.

Copy link

linear bot commented Apr 8, 2024

TBX-1549 Move the sample-workflow into a new tilebox-go-demo repo

To have a similar organisation as in python

@lukasbindreiter
Copy link
Contributor

Let's rename the top level folder to workflows instead of workflows-service. Service is something we use internally, but it doesn't make much sense here I think (+ that folder contains client and server logic anyways)

@lukasbindreiter
Copy link
Contributor

Can we improve the README a tiny bit, with just the essentials of:

How to install? I'm imagining a go get command I can copy paste + the git config for accessing a private repo.

  • Then I think it's good to show a minimal usage example of simple full main.go where we create a JobClient and then add a comment, now submit a task like this: //job_client.submit... (so that we don't need an actual task in the minimal example)

But this way you can immediately see the package name from the README, and know where you can start exploring the package in your IDE.

what do you think?

@lukasbindreiter
Copy link
Contributor

The tests in github actions are still commented out, will you add that in a later PR?

@corentinmusard corentinmusard force-pushed the corentinmusard/tbx-1549-move-the-sample-workflow-into-a-new-tilebox-go-demo-repo branch from 24ee52f to 3c05b6f Compare April 8, 2024 14:47
@corentinmusard corentinmusard merged commit 71c7d7f into main Apr 8, 2024
1 check passed
@corentinmusard corentinmusard deleted the corentinmusard/tbx-1549-move-the-sample-workflow-into-a-new-tilebox-go-demo-repo branch April 8, 2024 14:51
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.

2 participants