In the newest episode of this series, looking at the best practices for contributing to open-source web frameworks, I spoke with Brandon Bayer, Founder of Flightcontrol and Creator of Blitz.js. If you would like to check out that interview, you can see it here.
What is Blitz.js?
Blitz.js is a web framework built on Next.js that offers out-of-the-box features including a “Zero-API” data layer that eliminates the need for REST/GraphQL, and was modeled after Ruby on Rails.
What to Know Before You Get Started
Developers who are interested in contributing to Blitz.js should visit the Blitz.js repository, read the documentation to learn how to contribute, and discover more about the community!
- Check out Blitz Project Dashboard on Github, and view the “ready to work on” column for issues that have been unassigned and need help!
- Join the Discord and get involved in the community!
The Best Way to Get Started
Those who are just getting started with contributing to Blitz.js can help with code reviews, documentation, and addressing issues in the “ready to work on” column in the Blitz.js repository. If you are interested in working on a particular issue, you can comment on it, it will be assigned to you, and then you can start working on it.
- To find ideal issues for new contributors, look for the tags “good first issue” and “second first issue”.
- If you are using Blitz and you find a bug, you are encouraged to bring that to the attention of maintainers.
- If you are looking to build relationships and get involved on a regular basis, you can become a maintainer. There are different levels of maintainers like L1, L2, and Core Team. On the Blitzjs.com documentation page, there are descriptions on what it means to be what type of maintainer.
How to Submit a PR
Once you submit a PR, someone should review it within a few days, possibly request that you make changes, and then it may be merged. Sometimes PRs might be on hold until there is a release, but usually they are merged immediately.
The Blitz.js team doesn't have a lot of people reviewing PRs, so contributors are welcome to look at PRs and comment to make suggestions!
What About Attending Core Team Meetings?
Currently, the Core Team does not offer contributor meetings. However, earlier in the framework’s history, the Core Team hosted meetings that were recorded and shared on the Blitz.js Youtube channel if you would like to review old meetings.
__Are There Ways to Contribute to the Ecosystem Without Coding?
Those interested in contributing to the Blitz.js ecosystem without contributing code can:
- Help triage issues when new issues come through - if there is a bug, see if you can reproduce it, or ask the original person for details.
- Speaking at meetups and conferences.
- Making courses and writing books.
- Translating the docs into other written languages.
- Contribute anything that can spread the word about Blitz.js!
Blitz.js Success Stories
Aleksandra, who is a TypeScript expert, started using and contributing to Blitz.js. Whenever there was a particularly challenging problem with Blitz in TypeScript, Brandon Bayer would go to her and ask for help. That led to her working full time for Blitz.js!
Level 2 maintainers Simon and Juan have been successful too. Simon, who has only recently gotten started with the project, has been super helpful in building items like SuperJSON. Juan got started through translating docs, and he’s been working as a Maintainer ever since.
Ready to Begin?
You can find the Blitz.js Github repository here.