Thanks for your interest in contributing to Roll Your Own Auth. We're happy to have you here.
Please take a moment to review this document before submitting your first pull request. We also strongly recommend that you check for open issues and pull requests to see if someone else is working on something similar.
If you need any help, feel free to reach out to @smakosh.
This repository is a monorepo.
- We use pnpm and
workspaces
for development. - We use Turborepo as our build system.
- We use changesets for managing releases.
This repository is structured as follows:
apps
└── docs
examples
└── [rest-graphql]-[framework]-[orm]-[session-jwt]-[database]
packages
└── cli
Path | Description |
---|---|
apps/docs |
The Docs. |
examples/ |
All the examples/templates. |
packages/cli |
The ryo-auth package. |
You can fork this repo by clicking the fork button in the top right corner of this page.
git clone https://github.com/your-username/roll-your-own-auth.git
cd roll-your-own-auth
git checkout -b my-new-branch
pnpm install
You can use the pnpm --filter=[WORKSPACE]
command to start the development process for a workspace.
- To run the
roll-your-own-auth.vercel.app
website:
pnpm --filter=docs dev
- To run the
ryo-auth
package:
pnpm --filter=ryo-auth dev
The documentation for this project is located in the docs
workspace. You can run the documentation locally by running the following command:
pnpm docs:dev
Documentation is written using MDX. You can find the documentation files in the apps/docs
directory.
Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.
When you create a commit we kindly ask you to follow the convention
category(scope or module): message
in your commit message while using one of
the following categories:
-
feat / feature
: all changes that introduce completely new code or new features -
fix
: changes that fix a bug (ideally you will additionally reference an issue if present) -
refactor
: any code related change that is not a fix nor a feature -
docs
: changing existing or creating new documentation (i.e. README, docs for usage of a lib or cli usage) -
build
: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies -
test
: all changes regarding tests (adding new tests or changing existing ones) -
ci
: all changes regarding the configuration of continuous integration (i.e. github actions, ci system) -
chore
: all changes to the repository that do not fit into any of the above categoriese.g.
feat(components): add new prop to the avatar component
If you are interested in the detailed specification you can visit https://www.conventionalcommits.org/
Still too early, will write down more details once basic functionalities are implemented.
Still too early, will write down more details once basic functionalities are implemented.