Are you interested in getting some open source experience? Maybe it’s a goal for you at your job this year or maybe you just want to give back to the community. Whatever your reason, the Front End Developer Interview Questions repo is looking for help updating the translation of the interview questions into 33 different languages.
I’ve created 33 separate issues for each of our supported languages. Some of those languages are extremely out of date. Others have been updated regularly. Whatever the state, I’d like to get them all in sync with the current list of questions and then figure out a method for keeping them updated going forward.
If you’re a native speaker or are fluent in any of the languages we support please consider helping out. The only technical skills you need are markdown editing, although you will need to be aware of technical terms in order to properly translate the text.
Thanks in advance.
I know what you’re thinking… Am I back to writing? Coding open source software? Hopefully. I’m about to drop H%BP 9.0.0, so there’s that at least.
Anyway, we’re talking about removing normalize.css from the project in this issue:
Drop Normalize.css · Issue #2939 · h5bp/html5-boilerplate
I am leaning towards removing it with no replacement, but I could be convinced to include a different reset if one is more actively maintained and geared toward the modern browser landscape. If you have thoughts, please share them on the issue.
This post outlines the configuration of the HTML5-Boilerplate repo as well as the basic process we use to manage the project. As Github has matured as a platform and HTML5 Boilerplate has matured as a project there are a lot of lessons to be learned from the way we run the show here.
This section will go through the way we configure the repo in GitHub. Open source projects get the full power of the platform and as a project we like to experiment with new GitHub features. Our current configuration might help you figure out some things you want to do in your own projects.
This section outlines the basic configuration options we use.
- We have a stub of a Wiki still, so we have wikis turned on. The most interesting page that remains is a history of the project written several years ago.
- We use the Issues feature heavily. We don’t yet have Issue Templates set up, but we do have adding them as an issue, so we’ll take advantage of them at some point.
- Discussions are enabled, but they haven’t been very useful so far.
The most visible portion of our configuration is the way we handle pull requests. At the most basic level, we require pull requests to add code to the repo and require a review to merge code. In addition we run several code quality checks on every pull request to make sure we’re not introducing anything we don’t want into the codebase.
We take advantage of the “draft” feature for PRs. This way we have visibility throughout the life of the PR.
Let’s take a look at how we configure our
main is the default branch and is our only protected branch. We use feature branches to add features and/or fix issues in the codebase. Other project configurations might require a long-running, similarly protected,
development branch but for us the single protected
main branch is enough for our purposes.
Our branch protection rules are as follows:
- We require a pull request (PR) with one approving reviewer to merge code
- In addition to the PR and approving reviewer, we require three status checks to pass before code can be merged
- Build with Node 16
- Build with Node 14
- We allow force pushes for project admins. While force pushes can create some head scratching moments for people who have cloned the repo and update before and after the force push, the ability to clean up the
HEAD of a public branch like this in an emergency is useful.
GitHub Actions and Other Checks That Run on
- We run a simple build status check. This is the most basic test you can run and is absolutely vital. If you can’t build your project you’re in trouble. Currently we’re testing against Node 14 and 16.
- We take advantage of our access to CodeQL analysis Free for research and open source don’t you know 🙂 We don’t have a ton of surface area to cover, but it’s nice to have this powerful code scanning tool available to us.
- We run a dependency review scan to see if any newly added dependencies add known security flaws. This is important for even us, but for a project that uses a larger number of third party dependencies, this sort of check is vital.
- We push any changes to
main to our HTML5-Boilerplate Template Repo
Since we’ve talked about some of our Actions, let’s look at the full configuration of our
build-dist.yaml is currently broken. We can’t push to
main without a code review, so this task is blocked. What I would like, (are you there, GitHub, it’s me, Rob) is to allow Actions to bypass branch protection rules. I think we’ll have to basically write a mini-bot that opens a PR whenever there are changes to
main and then pushes to the same branch until the PR is closed. In some ways that will be better as it will be less noisy in terms of bot pushes to main.
dependency-review.yml does what it says on the tin- it tests newly introduced dependencies for vulnerabilities.
publish.yaml is the action that publishes all the various versions of the project. When we create a new tag and push it to GitHub, this script publishes our npm package and creates a GitHub release and attaches a zip file of our
push-to-template.yaml pushes the
main to our template repo
spellcheck.yml automatically checks markdown files for typos with cSpell.
test.yaml runs our test suite.
CODE_OF_CONDUCT.md is our Code of Conduct, based on Contributor Covenant.
CONTRIBUTING.md contains our contribution guidelines.
ISSUE_TEMPLATE.md is our new issue boilerplate.
PULL_REQUEST_TEMPLATE.md is our new PR boilerplate.
SUPPORT.md points people to different (non-HTML5-Boilerplate) support resources
dependabot.ymlis our Dependabot configuration. We do
npm, monthly on two separate
package.json files, one in
src and one in project root.
That covers most of the interesting GitHub features and functionality that we use. We’re going to continue to keep this document up to date as we change things or new GitHub features.
main.css version 3.0.0 was just released. It’s actually a small release, but it carries a breaking change so we’ve bumped a major version. Here’s the glorious changelog:
sr-only class to
- Remove print
thead rule (#101)
- Remove Vendor-prefixed
- Lots of dev dependency and npm publishing updates
There’s more to come as we slowly but surely make our way towards HTML5 Boilerplate v9.0.0
Hey! It’s been a while. Sorry! I’m going to have a lot more content to share over the next few months, so get used to me writing again.
Anyway, we’re in the middle of creating HTML5 Boilerplate 9.0. As part of that release we have created a Github template repository.
As GitHub wrote when they unveiled the feature
Sharing boilerplate code across codebases is a constant pattern in software development. Bootstrapping a new project with our favorite tools and directory structures helps programmers go from idea to “Hello world!” more efficiently and with less manual configuration.
Today, we’re excited to introduce repository templates to make boilerplate code management and distribution a first-class citizen on GitHub. To get started, all you need to do is mark a repository as a template, and you’ll immediately be able to use it to generate new repositories with all of the template repository’s files and folders.
With all the mentions of “boilerplate” it’s like template repos were made for HTML5 Boilerplate. Nice.
Using them is pretty simple.
First, navigate to h5bp/html5-boilerplate-template. Once there, click on the “Use this template”
Next, you add the name you would like to use:
And that’s it. You’ve got a fresh repo with all the files from HTML5 Boilerplate ready to go.
That’s just a taste of the changes on offer. I’ll have more news as we get closer to the final release. I would love to have this release out before 2021 is over. We’ll see!