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

Split style-spec to a different repo #2149

Closed
HarelM opened this issue Feb 6, 2023 · 9 comments
Closed

Split style-spec to a different repo #2149

HarelM opened this issue Feb 6, 2023 · 9 comments
Assignees
Labels
💰 bounty L Large Bounty, USD 500 enhancement New feature or request

Comments

@HarelM
Copy link
Collaborator

HarelM commented Feb 6, 2023

Motivation

The style spec is a whole subject that deserves its own repo.
This new repo should facilitate for documentation and the style validation code.
It should also include the typescript definitions in that package (in npm).
This way, this repo can consume this package no matter how it is implemented internally.
As a starting point I would advise to simply move parts of this repo as is (without any code changes) and make sure everything works as expected, once this is done we can discuss the next step for this new repo, either creating a similar package for the native repo to use, refresh technology, change to json-scheme or whatever.
But the first step is to split this apart and define a proper interface.

Design Alternatives

Keep everything together in a single repo.

Design

Describe above - split to a different package, define an interface/API and use it

Acceptance criteria for the bounty:

  1. Style spec definition, validation, documentation are in a new repo, including CI of tests and publishing of package and docs.
  2. The code is removed from this repo, and this repo only depends on packages produced by the other repo

Link to bounty:
maplibre/maplibre#191

@HarelM
Copy link
Collaborator Author

HarelM commented Feb 6, 2023

Cc: @birkskyum @wipfli @louwers @ovivoda

@HarelM HarelM added enhancement New feature or request 💰 bounty L Large Bounty, USD 500 labels Feb 6, 2023
@birkskyum
Copy link
Member

birkskyum commented Feb 8, 2023

These four issues contain quite a lot of gotchas and pitfalls. I'd be able to plan and resolve them all, but it would likely take me a full week, which I unfortunately can't carve out for a bounty this size ~25$/h. Let's see if someone else wants to give it a go.

@HarelM
Copy link
Collaborator Author

HarelM commented Feb 8, 2023

Thanks for the summary of this. The current state is worse than I thought. I'll see what can be done.

@krishnaglodha
Copy link
Contributor

Hi @HarelM , please let me know if the task is available, I'd like to contribute to it

@HarelM
Copy link
Collaborator Author

HarelM commented Feb 27, 2023

Please coordinate with @birkskyum as he has started looking into it and started working on it.
This issue is dependant on different issues and it's probably the last one to be finished.

@birkskyum birkskyum self-assigned this Mar 9, 2023
@birkskyum
Copy link
Member

I Guess this can be closed now then - unless the expression test conundrum also is included here.

@HarelM
Copy link
Collaborator Author

HarelM commented Apr 7, 2023

Resolved by maplibre/maplibre-style-spec#88

@HarelM HarelM closed this as completed Apr 7, 2023
@maplibre maplibre deleted a comment from HarelM Apr 16, 2023
@maplibre maplibre deleted a comment from HarelM Apr 16, 2023
@wipfli
Copy link
Member

wipfli commented Apr 17, 2023

@birkskyum let's add a link to the bounty payment in opencollective here. So you could write something like:

"Expense on open collective: https://opencollective.com/maplibre/expenses/132832"

And then @HarelM can comment something like "The work has been completed and the bounty can be paid out"

@wipfli
Copy link
Member

wipfli commented Apr 17, 2023

https://maplibre.org/roadmap/step-by-step-bounties-guide/#3-claiming-a-bounty instructions are here

The doubly-linking might look like too much work, but I have seen a lot of expense requests on opencollective in other projects from people that did not do any work. So let us avoid scams and false payments by doing this doubly linking...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💰 bounty L Large Bounty, USD 500 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants