Thank you for your interest in this project. Contributions are welcome. Feel free to open an issue with questions or reporting ideas and bugs, or open pull requests to contribute code.
We are committed to fostering a welcoming, respectful, and harassment-free environment. Be kind!
Starting development is as easy as installing Python uv and running uv sync once.
In order to run the project in the new virtual environment, run uv run auth-user-mgr.
It is assumed that you contribute under the main license of the project and own all the rights to the content you submit.
This project follows the Conventional Commits specification for commit messages. This is critical to support proper automation of the release process and changelog generation.
When contributing to this project, please open a pull request with a clear description of the changes you have made. The title of your pull request should follow the conventional commit format (e.g., feat: add new feature, fix: correct a bug, etc.).
Ensure to use the Squash and merge option when merging your pull request.
Both the PR title and merge method are required for a proper release process (see below).
This project uses release-please and its respective GitHub Action to automate the release process. This automatically creates a pull request with the version bump and changelog updates whenever a commit is pushed to the default branch. The version bump is determined by the conventional commit messages in the commit history since the last release. Once the release pull request is merged, a new release will be published on GitHub.
The relevant configuration for release-please can be found in the .github/workflows/release-please.yaml file and the release-please-config.json file. Ensure that the branch and project names are correctly set up in the workflow file and configuration file to match your repository's structure.