Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 4.89 KB

CONTRIBUTING.md

File metadata and controls

80 lines (50 loc) · 4.89 KB
Raw

Welcome to the Spacedrive contributing guide

Thank you for investing your time in contributing to our project!

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Issues

Create a new issue

If you find an issue with the repository or have a feature request with Spacedrive, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. As a general rule. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

This project uses Cargo and pnpm. Ensure you have them installed before continuing.

Note: MacOS M1 users should choose the customize option in the rustup init script and enter x86_64-apple-darwin as the default host triple instead of the default aarch64-apple-darwin

  • $ git clone https://github.com/spacedriveapp/spacedrive
  • For Linux or MacOS users run: chmod +x ./.github/scripts/setup-system.sh && ./.github/scripts/setup-system.sh
    • This will install FFMPEG and any other required dependencies for Spacedrive to build.
  • $ cd spacedrive
  • $ pnpm i
  • $ pnpm prep - Runs all necessary codegen & builds required dependencies.

To quickly run only the desktop app after prep you can use:

  • $ pnpm desktop dev

To run the landing page

  • $ pnpm web dev - runs the web app for the embed
  • $ pnpm landing dev

If you are having issues ensure you are using the following versions of Rust and Node:

  • Rust version: 1.60.0
  • Node version: 17

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The Spacedrive team thanks you ✨.

Once your PR is merged, your contributions will be included in the next release of the application.

Credits

This CONTRIBUTING.md file was modelled after the github/docs CONTRIBUTING.md file, and we thank the original author.