Contribution Guide

Contributions are always welcome, no matter how large or small! Here we summarize some general guidelines on how you can get involved in the Squirrel Servers Manager (SSM) project.

Submitting Issues and Writing Tests

We need your help! If you find a bug, it's best to create an issue and follow the template we've created. Afterwards, create a pull request that replicates the issue using a test.

Developing SSM Server

In the server, we use Vitest unit tests for test coverage (located in ./server/src/tests). Reference

Submitting Contributions

Your contributions are highly appreciated. Here are some guidelines:

Setting Up a Branch

First, start by creating your own 'fork' of our repository.

# Clone the repository
git clone https://github.com/SquirrelCorporation/SquirrelServersManager.git

# Go to your local repository
cd SquirrelServersManager

# Ensure you are in the 'main' branch
git checkout main

# Pull the latest updates
git pull

# Create a new branch for your changes
git checkout -b <YOUR-BRANCH-NAME>

Making Changes

As you implement your changes, keep in mind to:

• Follow the existing code style.
• Write clear, concise commit messages.

Run all tests before submitting to ensure they pass.

Committing Your Changes

After making your changes, commit and push them to your GitHub repository.

# Add changes
git add .

# Commit the changes
git commit -m "<COMMIT-MESSAGE>"

# Push your changes to your repository
git push origin <YOUR-BRANCH-NAME>

Submitting a Pull Request

After pushing your changes, you can create a "pull request":

1. Go to the original repository you created your fork from.
2. Click on "Pull request".

On the "Pull request" page:

• Ensure the "base fork" is the original repository.
• Confirm the "base" is the branch where you want your changes – often 'main'.
• Assign "head fork" to your forked repository.
• Set "compare" to the branch with your changes.

Write a description of your changes and create the pull request.

Review Process

Maintainers will review your submission and may provide feedback. If there are no issues, your changes will be merged.

The clearer your pull request description, the faster and smoother the review process.