CONTRIBUTING.md

Contributing to Wolflith

Contributions are what make the open source community such a fantastic place to learn, inspire, and innovate. Any contributions you make are very much appreciated.

Getting started

Thank you for your interest in Wolflith and your willingness to contribute!

We encourage you to explore the existing issues to see how you can make a meaningful impact. This document will help you setup your development environment.

Install dependencies

Dependencies are all auto installed.

Local development

Fork the repo

To contribute code, you must fork the Wolflith repo.

Auto Setup

1. Clone your GitHub forked repo:

   sudo wget -qO /opt/PCSInstall.sh https://raw.githubusercontent.com/<github_username>/Wolflith/main/PCSMenu/PCSInstall.sh
   sudo chmod +x /opt/PCSInstall.sh
   sudo /opt/PCSInstall.sh --branch="staging"

2. Go to the Wolflith directory:

   cd /opt/Wolflith

Create a pull request

After making any changes, open a pull request. Once you submit your pull request, @NorkzYT will review it with you.

Issue assignment

We do not have a process for assigning issues to contributors. Please feel free to jump into any issues in this repo that you are able to help with. Our intention is to encourage anyone to help without feeling burdened by an assigned task. Life can sometimes get in the way, and we do not want to leave contributors feeling obligated to complete issues when they may have limited time or unexpected commitments.

We also recognize that not having a process can sometimes lead to competing or duplicate PRs. There's no perfect solution here. We encourage you to communicate early and often on an Issue to indicate that you're actively working on it. If you see that an Issue already has a PR, try working with that author instead of drafting your own.

We review PRs in the order of their submission. We try to accept the earliest one that is closest to being ready to merge.