twitter / .github Goto Github PK

Reason/Context

I am suggesting to update the Issue templates , currently we are using .md files instead of the brand new issue forms with .yml files.

Why to update it ?

• The .yml based issue templates makes it more easier to organize, ask your questions, add screenshots and choose other options as necessary
• Plus, we can add "custom" labels to the issue template which makes it more organized than having a bot/user do it.

Relevant screenshots

Am i willing to work on it ?

Yes, i will be glad to help an Opensource project grow more !

Detailed description

I am talking about the issue templates which can be wrote using .yml , inside the .github > ISSUE_TEMPLATES .
Yes the bot is cool TBH, but the .yml based issue template is cooler.

Currently we are throwing in a markdown based Issue template. The problem is the user may/maynot fill in some fields. Then the maintainers again would have to ask them to fill those. Additionally, It's also not much of a beginner friendly thing, because all someone would see is questions and might be confused on how to structure their issue.

So adding proper, structured issue templates would be helpful for both the contributors as well as the maintainers to manage their repository.

Features of adding these issue templates

• Required fields
• Less dependant on bots
• Proper options for mentioning their browsers , operating systems and more.
• Interactive Check boxes to confirm if they have read the guidelines and more.
• Better Developer experience.

Relevant screenshots

What currently it is :

What i am suggesting it to be :

At least for the @twitter org, we've seen a lot of issues with cla-assistant.io not reporting on CLA status. CLA Assistant has a new (alpha quality) GitHub Actions based workflow that does not rely on the cla-assistant.io service at all, and instead stores CLA signatures in a JSON file in a git repo. We've experimented with this on the https://github.com/twitter/template repo, and it seems to work quite well.

There are two key downsides to this integration:

1. it must be configured on a per-repository basis, since that is the only way GitHub Actions works. github/roadmap#52 tracks organization workflows, but there's no indication on what that will be available.
2. to fully work, it requires a personal access token with repo write permission, since that is required to rerun workflows. Without write permission on the repo doing CLA checking, a repo admin will need to rerun the CLA workflow after a new contributor has signed the CLA.

For #1, we will use a custom tool to replicate the workflow file across repositories. For #2, we will instruct repo admins to manually rerun the workflow. Fortunately, this is only necessary for brand new contributors, which doesn't happen too terribly often.

This issue will be used to track migration of all Twitter repositories to the new GitHub Actions based CLA workflow.

Well, since folks seem intent on doing their best to make Twitter reverse its decision on making their codebase open-source, I'd like to try and do something constructive here, instead. Apologies for posting in the wrong place, but I'd like to get something constructive done and the algorithm's issues tab sadly doesn't seem to be the right place to do it.

Anyway, on to the actual question:

How do I build this thing? It mentions in the README that there is neither a top-level BUILD nor WORKSPACE file, so I'm not sure what to do (if it wasn't already obvious, I've never used Bazel before, so apologies if this is obvious). Also, trying to poke through the code in VS Code, Metals complains that it can't find a build tool (which I'd assume is due to the lack of top-level build tools) — if there's a different IDE setup I should use, please tell me.

Again, apologies if I missed anything obvious, and apologies for posting in the wrong place, but I'm pretty new to both Scala and Bazel and I'd like to actually do something constructive.

It might be cool to have the ability for the Jobs link to show OSS roles if there are any, perhaps a GitHub action which checks for new roles and then alters which link to show?