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

Decide on project conventions #1

Closed
11 of 14 tasks
belak opened this issue May 27, 2022 · 29 comments
Closed
11 of 14 tasks

Decide on project conventions #1

belak opened this issue May 27, 2022 · 29 comments

Comments

@belak
Copy link
Member

belak commented May 27, 2022

Previous discussion was happening in https://github.com/chriskempson/base16/issues/74, but it would be best to continue discussion here if possible.

There are a number of things (at least in my mind) which still need to be figured out:

My TODO list (will be converted to issues or finished):

  • Contact Github support to make the base16-project/* repos are the "primary" repos and the chriskempson ones show up as forks.
    • Decide on resolution - we may have to break into a separate "network" of forks.
  • Add (more) new collaborators
  • Improve the base16-builder-go to make the build process easier
  • Look at adding CI for updating the schemes repo and maybe auto-updating template repos
  • Clear a bit of the PR backlog
  • Look at migrating existing issues and PRs (either automatically or by hand)
  • Update the README of the original repos to point to the new location and mention the "archived"-ish status.

We need to figure out a number of things:

  • Decide on acceptance criteria for PRs
  • Decide on acceptance criteria for repos
  • Figure out what to do about PRs on the original forks
  • Maybe decide on a code of conduct
  • How we want to update the readme to clean stuff up
  • Decide how we want to reach out to "unofficial" base16 templates and other projects
@JamyGolden
Copy link
Member

Decide how we want to reach out to other base16 projects

To clarify, do you mean the projects in the "unofficial templates" list? https://github.com/base16-project/base16#unofficial-templates

@belak
Copy link
Member Author

belak commented Jun 3, 2022

Decide how we want to reach out to other base16 projects

To clarify, do you mean the projects in the "unofficial templates" list? https://github.com/base16-project/base16#unofficial-templates

Yes, I'll update the wording.

@JamyGolden
Copy link
Member

I've contacted the maintainers of fnune/base16-vim to see if they're interested with maintaining any projects - tinted-theming/base16-vim#55. Mentioning this here for transparency.

@actionless
Copy link
Member

actionless commented Jun 10, 2022

in themix base16 plugin i was previously using yml configs from chriskempson's repository, where can i find these 2 files now with the new project structure?

https://github.com/themix-project/themix-plugin-base16/blob/master/sync_mirror.sh#L7-L8

@belak
Copy link
Member Author

belak commented Jun 12, 2022

in themix base16 plugin i was previously using yml configs from chriskempson's repository, where can i find these 2 files now with the new project structure?

In the 0.10.0 spec, we dropped the base16-schemes-source and base16-templates-source repos so we could greatly simplify builders. The schemes were replaced with the https://github.com/base16-project/base16-schemes repo, but I pushed an update to https://github.com/chriskempson/base16-schemes-source which should let the new schemes repo work with the old setup.

For templates, I've opened #3 to continue that discussion.

@actionless
Copy link
Member

actionless commented Jun 12, 2022

thanks @belak i tested the sync mirror and it still working as expected after your change, the only thing i've noticed what 1 colorscheme got removed during this migration:

$ git status | grep schemes | grep deleted
        deleted:    schemes/colors/colors.yml

( https://github.com/hakatashi/base16-colors-scheme )

UPD: ah sorry, false alarm - it was jsut duplicated file before:

$ git status | grep colors
        renamed:    schemes/colors/colors.yaml -> schemes/base16-project/colors.yaml
        deleted:    schemes/colors/colors.yml

i'll check it later regarding templates, thanks!

@JamyGolden
Copy link
Member

@joshgoebel could you transfer https://github.com/highlightjs/base16-highlightjs to base16-project?

@joshgoebel
Copy link
Contributor

Did we decide somewhere that all templates should live here?

@actionless
Copy link
Member

@joshgoebel as i understood, it's an open question at the moment: #3

@belak
Copy link
Member Author

belak commented Jun 22, 2022

I think highlightjs is a unique case because it's base16 support for another project. It could live in either place depending on who wants to be responsible for it. Though in general we've been transferring projects here if people are interested.

@actionless that issue is relevant, but I was thinking more from the perspective of "how do we support builders who want to build multiple themes?"

@joshgoebel
Copy link
Contributor

I think highlightjs is a unique case because it's base16 support for another project.

Yeah and the build products are checked into the main Highlight.js project as well, so I think it'll likely start where it's at for the moment.

@JamyGolden
Copy link
Member

What do you all think about this as a general template for base16-template projects? https://github.com/base16-project/base16-vim/pull/58/files

Having the the GitHub .github/ISSUE_TEMPLATE/feature_request.md and .github/ISSUE_TEMPLATE/bug_report.md templates files and the CONTRIBUTING.md file? I'm thinking of having them basically copies of each other with minor repo-specific adjustments. If you have any suggestions relating to that could you leave a comment on the PR?

@JamyGolden
Copy link
Member

@base16-project/base16-project-team I'm just pinging all the maintainers because I forgot to in the comment above.

@GordianDziwis
Copy link

Do we need a more detailed convention for syntax highlighting? There is a guide https://github.com/chriskempson/base16/blob/master/styling.md, but with Tree-sitter and LSP-semantic tokens the requirements for color schemes got more complicated.

@JamyGolden
Copy link
Member

@BonaBeavis yeah I think a more detailed convention sounds like a good idea. I feel like we should go through the general concepts of the project too and discuss what exactly makes them different from other concepts (eg. schemes, templates, builders, managers).

@JamyGolden
Copy link
Member

I've created github teams, assigned everyone to the relevant teams and added the teams as collaborators on the projects. Individuals -> assigned to a team -> assigned to a repo; instead of individuals -> assigned directly to a repo. This makes it easier to manage members and the repos. It also gives us the benefit of being able to assign a team to a ticket or issue and also @ mention a group of people responsible for something.

@martinlindhe
Copy link

Thanks for doing this @JamyGolden and the rest!

@joshgoebel
Copy link
Contributor

Is there a place (Twitter/other) for project specific announcements? Example: I just released a new Node builder release after 6 years of quiet...

@actionless
Copy link
Member

actionless commented Jul 1, 2022

Is there a place (Twitter/other) for project specific announcements? Example: I just released a new Node builder release after 6 years of quiet...

idk, mb we could create a subreddit for ourselves?

btw i believe what at least 2-3 of members should have access to org twitter and reddit accounts (although i'm not volunteering for those)

@actionless
Copy link
Member

In the 0.10.0 spec, we dropped the base16-schemes-source and base16-templates-source repos so we could greatly simplify builders.

In the 2022 spec, we dropped the airbags and ABS so we could greatly simplify the factories. 😺

@joshgoebel
Copy link
Contributor

I'd recommand https://1password.com/teams for credentials management - they give out free accounts to OSS projects... one presumes a place is needed to store "organization" level credentials (such as a twitter login, etc)...

@dumblob
Copy link

dumblob commented Jul 2, 2022

@joshgoebel from my "enterprisey" experience organizational credentials management is smoother (safer) with Bitwarden (not speaking about the fact the client is fully open source and there is even the Vaultwarden open source reimplementation of the server side).

@joshgoebel
Copy link
Contributor

I think this decision just comes down to brand awareness and trust... I use 1Password personally, we use it for Highlight.js, and I have pushed several clients that direction over the years - always with good outcomes. We're a small org... and Teams is great for that so far IME - though I'm not sure how it would scale to like 5000 people...

@belak
Copy link
Member Author

belak commented Jul 2, 2022

I use 1Password for my family account and we use it at DataDog with thousands of people. I'd be the most comfortable with that - I wasn't aware there was an open source team option for that, but I'll try reaching out this week to get that set up.

That being said, is there much value right now in setting up a subreddit or a Twitter account? It seems like we might be getting a bit ahead of ourselves.

@joshgoebel
Copy link
Contributor

I dunno about Reddit. Twitter would just be nice if we're going to have momentum early on - give us a place to announce new things... new builders, new features, new versions of the spec... but that requires followers... so...

@GordianDziwis
Copy link

When defining a spec we should include the token from the lsp highlighting spec. I think with the success of the lsp, those will be the defacto standard.

@joshgoebel
Copy link
Contributor

joshgoebel commented Aug 31, 2022

Neat idea, though things like class, function, interface scare me because they are ambiguous... does it refer to the literal class definition, or merely the class name...

Highlight.js had a period where we tried to do both for different languages but over time we squashed that and said: we highlight keywords/syntax - we don't understand languages - so we don't know what a "class definition" is, but we can highlight a "class name"... but even then we no longer use class, we call it title.class or in TextMate lingo what would be entity.name.class

@GordianDziwis
Copy link

Neat idea, though things like class, function, interface scare me because they are ambiguous... does it refer to the literal class definition, or merely the class name...

It is all very WIP.

Highlight.js had a period where we tried to do both for different languages but over time we squashed that and said: we highlight keywords/syntax - we don't understand languages...

This is exactly where it would be helpful to rely on the lsp highlighting spec. We would not have to worry how the defined highlights are mapped to a specific language, this will be done by the corresponding lsp server implementation.

@belak
Copy link
Member Author

belak commented Dec 17, 2023

I'm closing this in favor of #84, where we're collecting all remaining project management related questions.

@belak belak closed this as completed Dec 17, 2023
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

No branches or pull requests

7 participants