deno.land / x / ultra@v2.3.8 / CONTRIBUTING.md
The easiest way to work on Ultra is to clone this repo and run the dev task. It will ask you which example you would like to work on and start that example in dev mode, so it can be used to test and work on changes to the Ultra codebase easily.
deno task dev
Before submitting a PR make sure that the following commands are run without error:
deno fmt
deno lint
deno task test
Note that deno fmt
needs to be run on any changes to markdown or other
non-source code files.
The name or description of a Pull Request should be prefixed (pre-appended) with one of the following tokens (adapted from the Conventional Commits standard):
Please note:
Note that a PR might contain code that covers a number of overlapping areas, such as one involving a new feature and containing tests. Select the prefix that encompasses the majority of the PR's code.
Although not required, it is a good idea to prefix commit descriptions too.
Here are some PR naming examples with a proper prefix ():
feat: Add CSS compression
fix: End-to-end test fixes
doc(contrib): Update contributor guidelines
chore(build): Update Deno version
refactor!: Convert Ultra to Angular
Naming PRs in this fashion will help in the creation of release notes.
Our coding style standard follows the Deno style guide (DSG). Please pay particular attention to the following style guide items:
While we encourage new contributions, it's a good idea propose a code change or new feature on Discord before you start development.
This repo has VSCode editor configs to help when working on this project. They
are found in the .devcontainer
and .vscode
folders.
If there is a simple config that doesn't conflict with other tooling and makes your life easier, feel free to open a PR with it.
Version Info