Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 2.14 KB
Raw

🥇 Introduction

First off, thank you for considering contributing to gSubs. It's people like you that make gSubs such a great tool and what it is today.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

gSubs is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into gSubs itself.

⚡️ Contributing

gSubs is completely open-source. If you'd like to help out by adding features, working on bug fixes, or assisting in other parts of development, here's how to get started:

To begin working locally:
  1. Fork this repository to your own GitHub account
  2. Clone it to your local device: git clone [email protected]:sanjevirau/gsubs.git
  3. Install the dependencies: npm install
  4. Run the app by starting electron, building the code and watch for changes: npm start
    To build for production (should not generally be used):
  5. Build the actual app for Windows: npm run dist
  6. gSubs can also be build into Mac and Linux by change the dist script to build -wlm --config in the package.json file and then building the app using npm run dist

We does give you credits for your contributions. Every contributors name will be shown in our contributors page at gSubs Contributors.

☕ Financial Contribution

If this project helps you in any way making your life easier, you can give us some donation to get gSubs released in Mac OS and Linux.