Home Blog Projects Services Donate

SudoVanilla Contribution Guide

This guide outlines the standards, workflows, and policies to make your contribution process smooth and effective. This contribution guide applies to all projects under the SudoVanilla and MinPluto name such as Redpoint, Nekoma, ButterflyVu, etc.

Knowledge

Required Fundamentals

Contributors must understand basic web technologies. You need a solid grasp of HTML structure, CSS styling, and JavaScript logic. Knowing other aspects like Deno and TypeScript is a good bonus.

Framework Focus

The vast majority of SudoVanilla projects run on Astro. Familiartiy with the Astro Web Framework component system and routing architecture is highly recommended.

As of August 2026, SudoVanilla is transitioning some of these projects over to its own in-house framework, known as Redpoint. Redpoint tries to follow the same structure as Astro, mostly.

Generative AI Policy

Strict Prohibition of AI Tools

SudoVanilla values human creativity, learning, and code ownership. You may not use Large Language Models(LLMs), chatbots, or AI assistants to generate content for SudoVanilla projects. This includes tool such as, but not limited to, ChatGPT, Claude, GitHub Copilot, Tabnine, Gemini, and Jetbrains AI.

If contributions are suspected of using AI, it will be closed without review. Repeated violation will result in your SudoVanilla Ark account being fully suspended permanently.

How to Contribute

1. Finding the Issue

First, look for open issues in the specific repository. you can filter by labels like good first issue or help wanted. Please comment on the issue to request assignment before starting work.

2. Forking and Branching

Fork the repository to your own account. Close the repository locally. Create a descriptive feature branch:

git checkout -b feature/your-feature-name-here

3. Coding Standards

Follow the existing code style of the repoistory. Write clean, readable code with meaningful variable names. You must include comprehensive tests for all new feature and bug fixes.

SudoVanilla enforces PascalCasiing across it’s naming conventions. If a function contains only one line of code, you must minify it into a single line.

function FunctionName({Message: string}) {console.log(Message)}

4. Commit Messages

Write clear, concise commit messages.For example: Fix authentication timeout bug on dashboard. Reference the issue number if applicable, such as Close #24.

Submitting a Pull Request

Push your branch to your forked repository. Open a pull request against the main or default branch of the target repository. Fill out the provided template, if present, using your own words.

Discussions

If you don’t understand parts of the codebase or why it’s the way it is, feel free to reach out via issues or contacting SudoVanilla via other communications channels like Mastodon, Email, Fluxer, Signal, or XMPP.

If it’s related to Redpoint, you can reach out via Redpoint Community website.

Review Process

Feedback

SudoVanilla will review your pull request, Be prepared to answer questions and make requested changes.

Merging

Once approved and all checks pass, SudoVanilla will merge your work.