Skip to content
This repository has been archived by the owner on Apr 28, 2024. It is now read-only.

Latest commit

 

History

History
36 lines (23 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

36 lines (23 loc) · 1.5 KB
Raw

Contributing to Slashbase

Thanks & Cheers for taking time and interest in contributing to Slashbase 🙌 🙏 👏

The following is a set of guidelines for contributing to Slashbase.

Table Of Contents

Important Resources:

Setup Development Environment

To contribute code to the repository, you need to setup the development environment. To do that, you can follow the following steps:

  1. Clone or Fork-Clone the GitHub repo and open it in your preferred IDE (VS-Code recommended).
  2. Go to the project root directory and copy the file at development.env.sample and paste as development.env in the root directory of the project.
  3. Install wails by following the steps on wails.io website.
  4. Run wails doctor to check if you have everything needed.
  5. Open terminal at the project root directory & run wails dev to start dev app.
  6. Create a new branch and make changes to the code.
  7. Run wails dev to test changes and make sure the changed code runs.
  8. Push your code and send PR.

Report a bug

You can report bugs or any issues in GitHub Issues. Put relevant bug & backend, frontend or cli or all relevant labels to the issue.

File a feature request

You can file feature request in GitHub Issues. Put feature request label to the issue.