Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (64 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

93 lines (64 loc) · 2.78 KB

Contributing to Logport

First off, thank you for considering contributing to Logport! Your help makes our platform stronger, faster, and more reliable for everyone.

This document outlines how to contribute effectively and get your changes merged smoothly.

Table of Contents

  1. How Can I Contribute?
  2. Reporting Issues
  3. Proposing Changes
  4. Pull Request Process
  5. Code Style and Linting

How Can I Contribute?

We welcome contributions of all kinds! Some ways to help:

  • Bug fixes – Spot a problem? Submit a fix.
  • New features – Have an idea to make Logport better? Propose it.
  • Documentation improvements – Clearer docs help everyone.
  • Testing – Add tests or improve coverage.
  • Translations – Make Logport accessible in more languages.

Any contribution, no matter how small, is appreciated.

Reporting Issues

If you find a bug or have a feature request:

  1. Check existing issues to see if it’s already reported.

  2. If not, create a new issue with:

    • A descriptive title
    • Steps to reproduce (for bugs) or expected behavior (for features)
    • Screenshots or logs if helpful

Issues are the best way to start a conversation before you begin working.

Proposing Changes

Before writing code:

  1. Create an issue first describing what you want to do.
  2. Discuss and get feedback — this saves wasted effort and ensures your work aligns with project goals.

Pull Request Process

We follow trunk-based development, so here’s the workflow:

  1. Fork the repository.

  2. Create a new branch for your change:

    git checkout -b my-feature-branch

  3. Make your changes and commit with clear messages.

  4. Push your branch to your fork.

  5. Open a pull request (PR) against the master branch of the main repo.

  6. Link the PR to the relevant issue.

  7. A maintainer will review, provide feedback, and merge once approved.

Code Style and Linting

To keep Logport consistent and maintainable, we follow specific code style rules for both backend and frontend. All contributions must pass these checks before merging.

Backend

  • There is an .editorconfig file at the root of the repository. Said file contains the formatting rules for any C# backend code written. Execute the snippet below to apply the formatting rules.

    dotnet format

  • The CI pipeline enforces formatting automatically:

    dotnet format --verify-no-changes --no-restore

Frontend

  • Use TypeScript and React functional components.
  • Lint and check formatting while on the LogPort.UI project with: 
    npm run lint
npm run format