Skip to content

Latest commit

 

History

History
115 lines (82 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

115 lines (82 loc) · 3.76 KB
Raw

Contributing Guidelines

First off, thank you for considering to contribute to this project!

Phantasm uses a wide-range of technologies and tools from different software development ecosystems. Therefore, we welcome contributions from all skill levels and backgrounds. We believe that a diverse community leads to a better product.

Project Structure

Phantasm consists of three main components: Server, Dashboard, and Client. The Dashboard and Client components are located in the dashboard and clients directories, respectively, while the Server component is located in the src directory.

Before you get started with contributing, you might need to set up your local development environment by installing the necessary dependencies. These are some of the primary technologies used to build Phantasm by its components:

  • Server: Rust, Tonic, gRPC, Tokio, Tungstenite
  • Dashboard: TypeScript, SvelteKit, Tailwind CSS
  • Client: Varies depending on the programming language

Where to Start

If you are new to the project, we recommend you to start by reading the project's documentation. The documentation provides an overview of the project, its components, and how they work together. If you have any questions, feel free to ask in the project's Discord server.

After familiarizing yourself with the project structure, you can start to work on an issue that is listed in the Issues section of the project's repository. Some great issues to start with are the ones labeled as good first issue.

Starting Development

Server

To start the server in development mode, you need to have Rust and Protobuf Compiler installed on your system. You can install them by following the instructions on their respective websites:

After installing the dependencies, you can run the following commands:

# Test the server functionality.
cargo test

# Check the CLI options.
cargo run -- --help

# Start the server using the CLI.
cargo run start

Dashboard

The dashboard is a web-based application built with SvelteKit. To start the dashboard in development mode, you need to have Node.js and NPM installed on your system. Assuming that you have them installed, you can run the following commands from the dashboard directory:

# Install the dependencies.
npm install

# Start the development server.
npm run dev

Documentation Website

Phantasm's documentation website is built with MkDocs Material. To start the documentation website in development mode, you need to have Python and PIP installed on your local machine. Assuming that you have them installed already, you can run the following commands from the root directory:

# Create a virtual environment.
python -m venv .venv

# Activate the virtual environment.
source .venv/bin/activate

# Install the dependencies.
pip install -r requirements.txt

# Start the development server.
mkdocs serve

Style Guides

To maintain a consistent codebase, we follow a set of style guides for each component of the project. These style guides include settings from rustfmt for the Server, Prettier for the Dashboard, and the respective formatters for the Client Libraries, that you can find in their configuration files, such as Black for Python.

Commit Messages & PRs

To ensure that the project's commit history is clean and easy to read, we follow the Conventional Commits specification. When you are pushing changes to the project or creating a pull request, please make sure to follow this convention. In short, a commit message or a pull request title should look like this:

<type>(optional scope): <description>

Source: Convention Commits