Contributing to oneRepo
Reporting issues
Section titled Reporting issuesUse 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.
Requesting features
Section titled Requesting featuresUse the Feature Request issue template.
Code changes
Section titled Code changesPre-requisites
Section titled Pre-requisitesEnsure you have the following before beginning:
- â
Using a supported version of Node.js (
^18 || ^20
). - â Node.jsâs corepack is enabled.
- â
The
oneRepo
CLI is installed. - â Forked and cloned the repository.
Local development
Section titled Local development-
Use the
one
command-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.
Documentation changes
Section titled Documentation changes-
Run the documentation application:
-
After tsdoc or other code changes, collect the content to see generated updates:
Style guide
Section titled Style guideAlways capitalize the following words unless referred to in a context outside of their meanings from the glossary:
- Monorepo
- Root
- Workspace
- Graph
License
Section titled LicenseWhen you submit code changes, your submissions are understood to be under the same MIT License that covers the project.