github-starred/better-auth
2
0
Fork 0
mirror of https://github.com/better-auth/better-auth.git synced 2026-05-24 08:01:56 -05:00
Code Issues 2.5k Packages Projects Releases 112 Wiki Activity

Improve contributor onboarding: add architecture and plugin authoring documentation #2074

New Issue
Open
opened 2026-03-13 09:25:08 -05:00 by GiteaMirror · 4 comments
GiteaMirror commented 2026-03-13 09:25:08 -05:00
Owner
Copy Link

Originally created by @NWelde on GitHub (Oct 4, 2025).

Originally assigned to: @ping-maxwell on GitHub.

Is this suited for github?

  • Yes, this is suited for github

Is your feature request related to a problem? Please describe.

Currently, the CONTRIBUTING.md and documentation do not provide enough onboarding help for new contributors, especially for those interested in the plugin architecture. As a newcomer, it's difficult to understand how the core and plugins interact, or where to start contributing beyond the core packages. This can discourage new contributors or lead to duplicated effort and missed best practices.

Describe the solution you'd like

Add comprehensive plugin contributor documentation and onboarding:

  • Architecture Overview: Explain how the core and plugin system work, including extension points, plugin lifecycle, and where to look in the codebase.
  • Contribution Pathways: List areas suitable for new contributors, highlight good-first-issues, and give guidance on contributing to plugins vs. the core.
  • Clarify Plugin Policy: Clearly state what belongs in core vs. third-party plugins, and explain how to propose a core plugin (RFC/issue template, etc.).
  • Dev Environment Setup: Expand on local development for plugin packages, including scripts, debugging, and running example apps with local changes.

Ideally, these improvements would be added to CONTRIBUTING.md and/or a new "Plugin Authoring" doc in the /docs directory.

Describe alternatives you've considered

I've tried reading the current CONTRIBUTING.md and README, but they lack plugin-specific details. I also looked for a dedicated plugin guide or example and couldn't find one. The only hint is that core plugins are generally internal, but this doesn't help third-party authors get started.

Additional context

This would help grow the community and ensure plugin contributions are high quality and consistent with the project's standards. It would also reduce onboarding time and confusion for new contributors.

Originally created by @NWelde on GitHub (Oct 4, 2025). Originally assigned to: @ping-maxwell on GitHub. ### Is this suited for github? - [x] Yes, this is suited for github ### Is your feature request related to a problem? Please describe. Currently, the CONTRIBUTING.md and documentation do not provide enough onboarding help for new contributors, especially for those interested in the plugin architecture. As a newcomer, it's difficult to understand how the core and plugins interact, or where to start contributing beyond the core packages. This can discourage new contributors or lead to duplicated effort and missed best practices. ### Describe the solution you'd like Add comprehensive plugin contributor documentation and onboarding: - **Architecture Overview**: Explain how the core and plugin system work, including extension points, plugin lifecycle, and where to look in the codebase. - **Contribution Pathways**: List areas suitable for new contributors, highlight good-first-issues, and give guidance on contributing to plugins vs. the core. - **Clarify Plugin Policy**: Clearly state what belongs in core vs. third-party plugins, and explain how to propose a core plugin (RFC/issue template, etc.). - **Dev Environment Setup**: Expand on local development for plugin packages, including scripts, debugging, and running example apps with local changes. Ideally, these improvements would be added to CONTRIBUTING.md and/or a new "Plugin Authoring" doc in the /docs directory. ### Describe alternatives you've considered I've tried reading the current CONTRIBUTING.md and README, but they lack plugin-specific details. I also looked for a dedicated plugin guide or example and couldn't find one. The only hint is that core plugins are generally internal, but this doesn't help third-party authors get started. ### Additional context This would help grow the community and ensure plugin contributions are high quality and consistent with the project's standards. It would also reduce onboarding time and confusion for new contributors.
GiteaMirror added the documentation label 2026-03-13 09:25:08 -05:00
GiteaMirror commented 2026-03-13 09:25:09 -05:00
Author
Owner
Copy Link

@ping-maxwell commented on GitHub (Oct 5, 2025):

We do have a very basic plugin guide in our docs:
https://www.better-auth.com/docs/guides/your-first-plugin

In most cases I recommend reading through our codebase at existing plugins, simpler ones like the username plugin is a good place to start. (It's how I first started contributing to Better-Auth!)

At this time we're very focused on fixing any high priority issues, but it's definitely planned to document a lot more about how the overall Better-Auth architecture works, as well as better documentation for how plugins are created.

@ping-maxwell commented on GitHub (Oct 5, 2025): We do have a very basic plugin guide in our docs: https://www.better-auth.com/docs/guides/your-first-plugin In most cases I recommend reading through our codebase at existing plugins, simpler ones like the [username plugin](https://github.com/better-auth/better-auth/blob/canary/packages/better-auth/src/plugins/username/index.ts) is a good place to start. (It's how I first started contributing to Better-Auth!) At this time we're very focused on fixing any high priority issues, but it's definitely planned to document a lot more about how the overall Better-Auth architecture works, as well as better documentation for how plugins are created.
GiteaMirror commented 2026-03-13 09:25:09 -05:00
Author
Owner
Copy Link

@NWelde commented on GitHub (Oct 5, 2025):

That sounds great! I’d actually love to help with improving the documentation — especially since I’m just starting my contributions, I have a fresh perspective on what beginners might need when navigating the codebase or building their first plugin.

@NWelde commented on GitHub (Oct 5, 2025): That sounds great! I’d actually love to help with improving the documentation — especially since I’m just starting my contributions, I have a fresh perspective on what beginners might need when navigating the codebase or building their first plugin.
GiteaMirror commented 2026-03-13 09:25:09 -05:00
Author
Owner
Copy Link

@ping-maxwell commented on GitHub (Oct 6, 2025):

That sounds great! I’d actually love to help with improving the documentation — especially since I’m just starting my contributions, I have a fresh perspective on what beginners might need when navigating the codebase or building their first plugin.

Absolutely, that sounds awesome! Any contributions are welcomed :)

@ping-maxwell commented on GitHub (Oct 6, 2025): > That sounds great! I’d actually love to help with improving the documentation — especially since I’m just starting my contributions, I have a fresh perspective on what beginners might need when navigating the codebase or building their first plugin. Absolutely, that sounds awesome! Any contributions are welcomed :)
GiteaMirror commented 2026-03-13 09:25:09 -05:00
Author
Owner
Copy Link

@dosubot[bot] commented on GitHub (Jan 5, 2026):

Hi, @NWelde. I'm Dosu, and I'm helping the better-auth team manage their backlog and am marking this issue as stale.

Issue Summary

  • You requested enhanced onboarding documentation for contributors, including architecture overviews and clearer plugin authoring guidance.
  • A maintainer pointed out the existence of a basic plugin guide and suggested reviewing simpler plugins as a starting point.
  • There is an acknowledgment of plans for more comprehensive documentation in the future.
  • You expressed willingness to help improve the documentation, which was warmly welcomed by the maintainer.
  • The discussion shows a collaborative intent to support new contributors better through improved docs.

Next Steps

  • Please let me know if this issue is still relevant to the latest version of better-auth by commenting here to keep the discussion open.
  • Otherwise, this issue will be automatically closed in 7 days.

Thank you for your understanding and contribution!

@dosubot[bot] commented on GitHub (Jan 5, 2026): Hi, @NWelde. I'm [Dosu](https://dosu.dev), and I'm helping the better-auth team manage their backlog and am marking this issue as stale. **Issue Summary** - You requested enhanced onboarding documentation for contributors, including architecture overviews and clearer plugin authoring guidance. - A maintainer pointed out the existence of a basic plugin guide and suggested reviewing simpler plugins as a starting point. - There is an acknowledgment of plans for more comprehensive documentation in the future. - You expressed willingness to help improve the documentation, which was warmly welcomed by the maintainer. - The discussion shows a collaborative intent to support new contributors better through improved docs. **Next Steps** - Please let me know if this issue is still relevant to the latest version of better-auth by commenting here to keep the discussion open. - Otherwise, this issue will be automatically closed in 7 days. Thank you for your understanding and contribution!
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
adapter
astro
awaiting external contributor
blocked
breaking
breaking change
bug
c-devops
core
credentials
database
dependencies
devops
devtools
docs
documentation
duplicate
elysia
enhancement
enterprise
expo
express
fastify
good first issue
help wanted
hono
identity
infra
integration
invalid
javascript
locked
maintenance
need-more-information
needs: info
needs: repro
nextjs
nuxt
oauth
organization
P0
payments
perf
platform
plugin
pull-request
Mirrored from GitHub Pull Request
 question
ready
regression
remix
security
social-provider
solid
stale
svelte
tanstack-start
tracking
version-bump
vue
wontfix
No Label documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#2074
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?