Use the Bug Report issue template.
The template will guide you through asking for extra information. Fill out as much as possible to help maintainers help you faster.
Use the Feature Request issue template.
Ensure you have the following before beginning:
- ✅ Using a supported version of Node.js (
^18 || ^20). - ✅ Node.js’s corepack is enabled.
- ✅ The
oneRepoCLI is installed. - ✅ Forked and cloned the repository.
-
Use the
onecommand-line interface directly from the installed command.The CLI will properly pass-through and run the local source, so all of your changes will instantly be available for debugging.
-
Make your code changes.
-
Do your best to make changes easy to review:
- ✅ Add and update tests
- ✅ Adjust tsdoc comments
- ✅ Add documentation
- ✅ Ensure a pre-commit hooks run and pass
-
Create your pull request against the oneRepo repository.
Ensure that you check the box to “Allow edits and access to secrets by maintainers”. This will allow maintainers to help, collaborate, and move your changes through quicker with fewer back-and-forth requests.
:::caution[Generated content]
Most documentation requires a full terminal in order to ensure proper formatting, linting, and more. Furthermore if documentation appears within a signed @generated block, it is auto-generated, either using typedoc or from oneRepo docgen.
Please follow the steps for code changes before making documentation updates. :::
-
Run the documentation application:
one workspace docs start
-
After tsdoc or other code changes, collect the content to see generated updates:
one workspace docs collect-content
one workspace docs typedoc
Always capitalize the following words unless referred to in a context outside of their meanings from the glossary:
- Monorepo
- Root
- Workspace
- Graph
When you submit code changes, your submissions are understood to be under the same MIT License that covers the project.