Skip to content

Contribution Guidelines

Thank you for considering contributing to Loki! We welcome contributions from everyone, and we're excited to have you join our community. This document outlines the process for submitting changes and improvements to the Loki project.

Code of Conduct

Please note that this project is governed by a Code of Conduct. By participating, you agree to abide by its terms.

How to Contribute

There are many ways to contribute to Loki, including but not limited to:

  • Reporting bugs
  • Suggesting new features
  • Writing or editing documentation
  • Submitting code changes

Reporting Bugs

If you find a bug in Loki, please open an issue on our GitHub repository. Be sure to include a clear and concise description of the bug, along with steps to reproduce it. If possible, include a code snippet or a link to a reproducible example.

Suggesting New Features

If you have an idea for a new feature or improvement to Loki, please open an issue on our GitHub repository. Be sure to include a clear and concise description of the feature, along with any relevant use cases or examples.

Writing or Editing Documentation

If you find a mistake or want to improve our documentation, you can submit a pull request on our GitHub repository. Please follow the Documentation Style Guide when writing or editing documentation.

Submitting Code Changes

If you want to contribute code changes to Loki, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make your changes and commit them with a clear and concise commit message.
  5. Push your changes to your forked repository.
  6. Open a pull request on our GitHub repository.

Please make sure that your code changes are well-tested and follow our Coding Style Guide.

An easy way to ensure this is to simply run

dotnet format loki.sln
dotnet format loki.csproj

In a command shell at the project's root folder

License

By contributing to Loki, you agree that your contributions will be licensed under the same license as the project.