CONTRIBUTING.md

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
• Report a bug

Important Resources:

• docs.slashbase.com

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. Open terminal at the project root directory & do cd frontend, then do yarn install.
4. Open terminal at the project root directory & run go run main.go to run go backend server & cd frontend & yarn start to run frontend react.
5. The IDE is running at http://localhost:22022.
6. Create a new branch and make changes to the code.
7. Test and make sure the 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.