Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
128 lines (89 loc) · 5.18 KB

CONTRIBUTING.md

File metadata and controls

128 lines (89 loc) · 5.18 KB

Contributing to SkillDeck

First off, thank you for considering contributing to SkillDeck! It's people like you that make SkillDeck such a great tool. We welcome contributions of all kinds – not just code – including documentation, bug reports, feature suggestions, and community support.

Code of Conduct

This project and everyone participating in it is governed by the SkillDeck Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to conduct@skilldeck.dev.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with a clear title and detailed description.
  • Explain why this enhancement would be useful to most SkillDeck users.
  • If you're proposing a new feature, you may want to read the Vision Document first to understand the project's goals.

Your First Code Contribution

Unsure where to begin? You can start by looking through help-wanted and good-first-issue issues:

Contributing to Documentation

The SkillDeck documentation site lives in the skilldeck-user-docs/ folder and is built with Astro Starlight. We welcome improvements to the docs, including:

  • Fixing typos or clarifying existing content
  • Adding new tutorials, how‑to guides, or explanations
  • Improving code examples
  • Translating content into other languages

Setting Up the Docs Site Locally

  1. Ensure you have Node.js (v20 or later) and pnpm installed.
  2. Navigate to the docs folder: 
    cd skilldeck-user-docs
  3. Install dependencies: 
    pnpm install
  4. Start the development server: 
    pnpm run dev
  5. Open http://localhost:4321 in your browser. The site will automatically reload when you save changes.

Making Changes

  • All documentation content is in src/content/docs/. Files are organized by language (e.g., en/) and then by version (latest/, v0-2/, etc.). Most contributions should go under en/latest/.
  • If you're adding a new page, remember to include frontmatter at the top with title and description fields.
  • Use the custom components (Nudge, Checkpoint, Feedback) where appropriate – they're already imported and ready to use.

Submitting Docs Changes

  1. Fork the repository and create a branch (e.g., docs/fix-typo).
  2. Make your changes in the skilldeck-user-docs/ folder.
  3. Test locally to ensure everything looks correct.
  4. Commit your changes with a clear message (e.g., docs: fix typo in installation guide).
  5. Open a pull request against the main branch.

Pull Requests (Code)

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints (Rustfmt, Clippy, Biome).
  6. Issue that pull request!

Development Setup

Prerequisites

  • Rust (latest stable) – install via rustup
  • Node.js (v20 or later) – install via nvm or from nodejs.org
  • Tauri CLI – cargo install tauri-cli
  • pnpm (package manager) – npm install -g pnpm

Building and Running the App

  1. Clone the repository:

    git clone https://github.com/skilldeck/skilldeck.git
cd skilldeck

  2. Install frontend dependencies:

    pnpm install

  3. Run in development mode:

    pnpm tauri dev

This will start the Rust backend and the Vite dev server, and open the Tauri window.

Running Tests

  • Rust unit tests: cargo test --workspace
  • Rust integration tests: cargo test --test integration
  • React component tests: pnpm test
  • End-to-end tests: (coming soon)

Coding Style

  • Rust: We use rustfmt and clippy. Run cargo fmt and cargo clippy before committing.
  • TypeScript/React: We use Biome. Run pnpm lint and pnpm format.

Project Structure

See ARCHITECTURE.md for an overview of the codebase organization.

Community

Thank you for contributing! 🚀