Skip to content

docs: add Tinyauth contributing guide with development setup #80

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

Merged
steveiliop56 merged 1 commit into from
Apr 17, 2026
Merged

docs: add Tinyauth contributing guide with development setup #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 2 additions & 19 deletions src/content/docs/docs/contributing/contributing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,9 @@ git clone https://github.com/steveiliop56/tinyauth
cd tinyauth
```

## Initialize Submodules
## Installing Dependencies

The project uses Git submodules for some dependencies, so you need to initialize them with:

```sh
git submodule init
git submodule update
```

## Apply patches

Some of the dependencies must be patched in order to work correctly with the project, you can apply the patches by running:

```sh
git apply --directory paerser/ patches/nested_maps.diff
```

## Installing Requirements

While development occurs within Docker, installing the requirements locally is recommended to avoid import errors. Install the Go dependencies:
While development occurs within Docker, installing the dependencies locally is recommended to avoid import errors. Install the Go dependencies:

```sh
go mod tidy
Expand Down