Contributing Guide

Thanks for taking the time to join our community and start contributing. This guide will help you get started with the Filestash project.

How to contribute?

Before you submit a pull request

For anything else than a typo or a bug fix, please raise an issue to discuss your proposal before submitting any code.

License for contributions

As the copyright owner, you agree to license your contributions under an irrevocable MIT license.

Building from source

Prerequisites: Git, Make, Node, Go, Glib 2.0

# Download the source
git clone https://github.com/mickael-kerjean/filestash
cd filestash

# Install dependencies
npm install --legacy-peer-deps # frontend dependencies
make build_init # install the required static libraries
mkdir -p ./dist/data/state/
cp -R config ./dist/data/state/

# Create the build
make build_frontend
make build_backend

# Run the program
./dist/filestash

Tests

Our tests aren't open source. This comes as an attempt to restrict opportunistic forks (see 1 and 2) from creating a stable release without serious commitment and splitting the community in pieces while I'm on holidays. Also the project welcome serious and willing maintainers.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!