Skip to main content

​
Contributing

We welcome contributions to Vestauth! Whether you’re fixing bugs, adding features, improving documentation, or building new tools, your help is appreciated.

​
Ways to Contribute

Report Issues

Found a bug or have a feature request? Open an issue on GitHub.

Submit Pull Requests

Fork the repository and submit a pull request with your changes.

Join Discussions

Share ideas and discuss improvements with the community.

Build Tools

Create new tools that work with Vestauth and let us know to get listed.

​
Getting Started

1

Fork the repository

Visit github.com/vestauth/vestauth and fork the repository to your account.
2

Clone your fork

3

Create a branch

4

Make your changes

Implement your bug fix, feature, or documentation improvement.
5

Test your changes

Ensure everything works as expected and follows the project standards.
6

Submit a pull request

Push your changes and open a pull request with a clear description of your changes.

​
Development Guidelines

​
Code Quality

  • Follow existing code style and conventions
  • Write clear, descriptive commit messages
  • Add tests for new features when applicable
  • Keep changes focused and atomic

​
Documentation

  • Update documentation for any API changes
  • Include code examples where helpful
  • Keep language clear and concise

​
Pull Request Process

  1. Ensure your PR has a clear title and description
  2. Reference any related issues
  3. Wait for maintainer review
  4. Address any feedback or requested changes

​
Community

Follow on X

Stay updated with the latest news. DMs are open for questions and feedback.

​
Questions?

If you have questions or need help:
When opening an issue, provide as much context as possible including:
  • What you’re trying to accomplish
  • Steps to reproduce (for bugs)
  • Expected vs actual behavior
  • Your environment (OS, Vestauth version, etc.)