Skip to content

Fix some typos in CONTRIBUTING.md #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danielcristho wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix some typos in CONTRIBUTING.md #37

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adea851
docs: fix command typo
danielcristho Mar 7, 2026
5f327a6
docs: fix some typos
danielcristho Mar 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Contributing to the Render Engine Projects

Render Engine CLI is the CLI tool for the Render Engin static site generator. Please refer to
Render Engine CLI is the CLI tool for the Render Engine static site generator. Please refer to
the main [CONTRIBUTING.md](https://github.com/render-engine/render-engine/blob/main/CONTRIBUTING.md)
for more details on how to contribute.

## Render Engine CLI Specific Topics

Render Engine CLI is a `uv` based project. For more information on installing `uv` and using it
please see the [uv documentation](https://docs.astral.sh/uv/#installation).To get started, for
please see the [uv documentation](https://docs.astral.sh/uv/#installation). To get started, for
this repository and check out your fork.

```shell
Expand All @@ -34,6 +34,6 @@ uv pip install . && uv pip install -e .
**NOTE**: The above actually has you installing the CLI as uneditable and then as editable. This
is only needed as long as the main Render Engine install includes an entry point as there is a
conflict. The `uv pip install .` will overwrite the entry point for `render-engine` while the
second command, `uv pip insall -e .` will convert it to an editable install.
second command, `uv pip install -e .` will convert it to an editable install.

This will allow you to test your changes via the command line.