Skip to main content

Contributing

Thanks & Cheers for taking time and interest in contributing to Slashbase šŸ™Œ šŸ™ šŸ‘

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

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 a feature request inĀ GitHub Issues. PutĀ feature requestĀ label to the issue.