Contribution Guide

About 745 wordsAbout 2 min

2026-08-14 10:00:00

SecRandom welcomes anyone to submit code to our repository. You can help us in many ways, including but not limited to:

Submitting patches to fix bugs
Adding new features
Optimizing existing features
Improving code performance
Improving documentation and translations
More......

By reading this guide, you will understand the process of contributing code to SecRandom, including how to trigger binary builds with commit messages. Let's get started!

Version Notice

This document corresponds to the v3 (C#/.NET 10 + Avalonia) development flow. The old v2 (Python) flow no longer applies.

Quick Start

Before contributing code to SecRandom, please make sure you have completed the following:

Note

Besides the command line, you can also use GitHub Desktop or the built-in features/plugins of your IDE.

Fork the project
- Visit the SecRandom GitHub repository
- Click the "Fork" button in the top right to create your own copy
Clone the repository
Warning
Make sure to switch your terminal working directory to where you want to save/modify the SecRandom source code before this step.
```
git clone https://github.com/your-username/SecRandom.git
cd SecRandom
```

Add the upstream repository

git remote add upstream https://github.com/SECTL/SecRandom.git

Prepare the development environment
Tip
If you don't need to run the code to test, you can skip this part.
v3 requires the .NET 10 SDK (available from dotnet.microsoft.com).
```
# Restore dependencies
dotnet restore SecRandom.sln

# Build
dotnet build SecRandom.sln

# Run the desktop app
dotnet run --project SecRandom.Desktop
```

Submit Your Contribution

Create a branch
```
git checkout -b feature/your-feature
```
Make changes
- Write your code
- Add necessary comments
- Follow the project code style

Commit changes

git add .
git commit -m "Describe your changes"

Sync upstream changes

git fetch upstream
git rebase upstream/master

Push and create a Pull Request (PR)
```
git push origin feature/your-feature
```
- Visit your GitHub fork
- Click "Compare & pull request"
- Fill in the PR description and submit