✨ Thanks for your interest in contributing! ✨
The following is a set of guidelines for contributing; they are not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.
To ensure the project is kept open and inclusive, please read and follow the Code of Conduct
Given that the project is essentially simple build infrastructure with a release cycle that mirrors the Zeit Now CLI, the types of changes that will be considered are typically limited to fixes and improvements of:
- the Dockerfile - image size, documentation, best practices
- documentation - particularly regarding usage
- build & CI configuration - simplification, automation, or reliability related
Pull requests are very welcome and appreciated, however they should remain focused in scope, and a final submission should avoid containing unrelated commits.
Please ask first before embarking on any significant changes, or if you are uncertain if your changes are in line with the project's purpose.
To make changes to the project, you will require Docker and Yarn >= v1.13 so that tooling within the project works as expected.
To install Yarn, please see their official
installation instructions. Once
installed, simply run yarn in the root of the repository to install the
project's dependencies.
To install Docker, please see their official installation instructions.
This project follows a strict
commit message structure,
and while not required, you can ensure your commits adhere to this structure by
using the interactive commitlint CLI that is
included in the repository. After staging your files, simply run yarn commit
and follow the prompt.
During the commit process, git hooks are used to automatically format relevant files and catch syntax errors using prettier and dockerfmt.