Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (38 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

45 lines (38 loc) · 1.23 KB

Contributing to this project

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

Prerequisites

  1. Linux or windows operating system (MacOS is not tested but may work)
  2. .NET SDK 10.0 or later
  3. Git (Required for cloning the repository and gitversioning)
  4. Working c compiler for AOT builds
  5. A code editor such as Visual Studio, Visual Studio Code (optional)

Getting Started

  1. Fork the repository on GitHub
  2. Clone your forked repository to your local machine 
    git clone <your-forked-repo-url>
  3. Navigate to the project directory 
    cd Kryptor
  4. Build the project using the provided build script 
    ./build.sh -t build-all -c Debug
  5. Run tests to ensure everything is working correctly 
    ./build.sh -t test-all
  6. Start coding! Make your changes and improvements.

For windows, use build.ps1 instead of build.sh.

To see all avaiable build targets, run:

./build.sh --tree

or

./build.sh --description

to get detailed information about each target.