Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
104 lines (66 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

104 lines (66 loc) · 2.99 KB

Contributing to dev-oidc-toolkit

Thank you for your interest in contributing to dev-oidc-toolkit. We welcome contributions of all kinds — bug reports, feature requests, and pull requests.

This project is developed and maintained by Business Simulations and is licensed under the MIT licence.

📌 Quick links

🐛 Bug reports

If you've encountered a bug, please open an issue and include:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected and actual behaviour
  • Environment details (OS, browser/server, versions, etc.)
  • Any relevant logs, screenshots, or code snippets

Note: please check if the bug has already been raised before creating a new issue.

✨ Feature requests

We welcome new ideas. To request a feature or enhancement, open an issue and include:

  • A concise explanation of the feature
  • The motivation behind it (what problem it solves or improves)
  • Any alternatives or prior work considered

Note: please check if the feature has already been requested before opening a new issue.

🔧 Pull requests

We appreciate code contributions. Please follow these guidelines when submitting a pull request:

  1. Fork the repository and create your branch from main
  2. Write clear commit messages and keep your changes focused
  3. Include tests if you're adding or modifying functionality
  4. Ensure your code builds and passes all existing tests
  5. Reference related issues in your pull request description (e.g. “Closes #42”)

Once submitted, your pull request will be reviewed and discussed. Please be responsive to feedback.

🛠 Development setup

This section details how you can work on the project locally.

You will need these dependencies:

  • Dotnet v10+
  • Python 3+ (for documentation)

Follow these steps after forking and cloning the repository to run the project:

  1. Restore dependencies:
dotnet restore
  1. Run the application:
dotnet run --project DevOidcToolkit

Alternatively use watch to hot reload on changes:

dotnet watch --project DevOidcToolkit

To run the documentation follow these steps:

  1. Move into the documentation folder:
cd DevOidcToolkit.Documentation/
  1. Restore dependencies:
pip install -r requirements.txt
  1. Run the documentation development server:
mkdocs serve

Useful commands

  • dotnet format - formats the code to match coding style standards
  • dotnet test - runs unit tests

Architecture

Read the architecture document for details on this project's architecture.