Contributing Guide

Thank you for considering contributing to ConsoleTables! We welcome bug reports, feature requests, and pull requests.

Development Setup

To get started with the codebase, follow these steps.

  1. Fork the repository: Create your own fork of the ConsoleTables repository on GitHub.

  2. Clone your fork: 

    git clone https://github.com/YOUR_USERNAME/ConsoleTables.git
cd ConsoleTables

  3. Install .NET SDK: Ensure you have the .NET 9.0 SDK installed, as specified in the global.json file. You can download it from the official .NET website.

Building the Project

Once you have the code, you can build the solution from the root directory using the .NET CLI.

# Restore NuGet packages for all projects
dotnet restore

# Build the solution in Release configuration
dotnet build -c Release

The main library is located at src/ConsoleTables, the sample project is at src/ConsoleTables.Sample, and tests are at src/ConsoleTables.Tests.

Running Tests

We use xUnit for testing. To run all tests, use the following command:

dotnet test -c Release

All tests should pass before you submit a pull request. If you are adding a new feature or fixing a bug, please add corresponding tests to ensure correctness and prevent future regressions.

Submitting a Pull Request

  1. Create a new branch for your feature or bug fix: 

    git checkout -b my-awesome-feature

  2. Make your changes to the code.

  3. Commit your changes with a clear and descriptive message: 

    git commit -am "Add new feature for XYZ"

  4. Push your branch to your fork on GitHub: 

    git push origin my-awesome-feature

  5. Open a pull request from your fork to the main branch of the original khalidabuhakmeh/ConsoleTables repository.

  6. Provide a detailed description of your changes in the pull request. The project's GitHub Actions CI will automatically build and test your changes.