Skip to content

Commit

Permalink
Update contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DogmaDragon committed Nov 21, 2023
1 parent a2ed193 commit 9785b91
Showing 1 changed file with 6 additions and 24 deletions.
30 changes: 6 additions & 24 deletions in-app-manual/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ layout: clean
title: Ways to Contribute
nav_order: 14
parent: In-app Manual

---

<details markdown="block">
Expand All @@ -21,40 +20,23 @@ Financial contributions are welcomed and are accepted using [Open Collective](ht

# Development-related

The Stash backend is written in golang with a sqlite database. The UI is written in react. Bug fixes, improvements and new features are welcomed. Please see the [README.md](https://github.com/stashapp/stash/blob/develop/docs/DEVELOPMENT.md){:target="_blank"} file for details on how to get started. Assistance can be provided via our [Discord](https://discord.gg/2TsNFKt){:target="_blank"}.
The Stash backend is written in Go, using a SQLite database. The UI is written in Typescript, using React. Bug fixes, improvements and new features are welcomed. Please see the [DEVELOPMENT.md](https://github.com/stashapp/stash/blob/develop/docs/DEVELOPMENT.md){:target="_blank"} file for details on how to get started. Assistance is available via our [Discord](https://discord.gg/2TsNFKt){:target="_blank"}.

# Documentation

Efforts to improve documentation in stash helps new users and reduces the amount of questions we have to field in Discord. Contributions to documentation are welcomed. While submitting documentation changes via git pull requests is ideal, we will gladly accept submissions via [github issues](https://github.com/stashapp/stash/issues){:target="_blank"} or on [Discord](https://discord.gg/2TsNFKt){:target="_blank"}.
Efforts to improve documentation in Stash helps new users and reduces the number of questions we have to field in Discord. Contributions to documentation are welcomed. While submitting documentation changes via GitHub pull requests is ideal, we will gladly accept submissions via [GitHub issues](https://github.com/stashapp/stash/issues){:target="_blank"} or on [Discord](https://discord.gg/2TsNFKt){:target="_blank"}.

For those with web page experience, we also welcome contributions to our [website](https://stashapp.cc/){:target="_blank"} (which as of writing is very undeveloped).

# Testing features, improvements and bug fixes

Testing is currently covered by a very small group, so new testers are welcomed. Being able to build stash locally is ideal, but custom binaries for pull requests are available by navigating to the `continuous-integration/travis-ci/pr` travis check details.

The link to the custom binary for each platform can be found at the end of the build log, and looks like the following:
```
$ if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then sh ./scripts/upload-pull-request.sh; fi
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 43.1M 100 35 100 43.1M 3 3812k 0:00:11 0:00:11 --:--:-- 5576k
stash-osx uploaded to url: https://transfer.sh/.../stash-osx
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 60.7M 100 39 100 60.7M 3 5391k 0:00:13 0:00:11 0:00:02 7350k
stash-win.exe uploaded to url: https://transfer.sh/.../stash-win.exe
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 44.6M 100 37 100 44.6M 2 3648k 0:00:18 0:00:12 0:00:06 7504k
stash-linux uploaded to url: https://transfer.sh/.../stash-linux
```
The `if` line will need to be expanded to see the details.
Testing is currently covered by a very small group, so new testers are welcomed. Being able to build Stash locally is ideal, but binaries for pull requests are also available.

First, you will need to be signed in to GitHub. Find and open the relevant pull request, and then click on the `Checks` tab. On the right, there should be a button titled `Artifacts` - click that, and you should get a dropdown with links to download binaries built from that pull request for Linux, Windows and macOS.

# Submitting and contributing to bug reports, improvements and new features

We welcome contributions for future improvements and features, and bug reports help everyone. These can all be found in the [github issues](https://github.com/stashapp/stash/issues){:target="_blank"}.
We welcome ideas for future improvements and features, and bug reports help everyone. These can all be found on [GitHub](https://github.com/stashapp/stash/issues){:target="_blank"}.

# Providing support

Expand Down

0 comments on commit 9785b91

Please sign in to comment.