Skip to content

Latest commit

 

History

History
124 lines (88 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

124 lines (88 loc) · 3.28 KB
Raw

How to contribute

I'm really happy you're considering contributing to StaticBackend. There's so much to do from tiny things to large features, every help is more than welcome.

If you haven't join our Discord server, please do.

I'll start by saying, don't hesitate to ask any questions. I'm personally always happy to help, especially if it's your first time contributing to an open-source project.

Here are what we're using to maintain the project:

Discord for general and real-time discussions.

GitHub discussions for questions, new ideas, and such.

GitHub issues for bugs and features that has been discussed and approved.

Run the tests

Here's what you'll need to run the tests:

  • Go 1.18+
  • Either Docker or local PostgreSQL, Mongo, and Redis
  • Environment variables in an .env file

Please note that since v1.5 there's an SQLite data provider removing the need to have PostgreSQL/Mongo. Also there's a memory cache implemented removing the need to have Redis installed.

Here's my dev .env file:

APP_SECRET=a-very-long-key-should-be-32long
APP_ENV=dev
APP_URL=http://localhost:8099
JWT_SECRET=tiaAvfn

# For PostgreSQL
#DATABASE_URL=host=localhost user=postgres password=postgres dbname=postgres sslmode=disable
#DATA_STORE=pg

# For MongoDB
#DATABASE_URL=mongodb://localhost:27017
#DATA_STORE=mongo

# For SQLite
#DATABASE_URL=dev.db
#DATA_STORE=sqlite

# For the memory provider
DATABASE_URL=mem
DATA_STORE=mem
# Dev email (printed to terminal)
MAIL_PROVIDER=dev
[email protected]
FROM_NAME=StaticBackend

# For Redis cache
#REDIS_HOST=localhost:6379
#REDIS_PASSWORD=

# For the in-memory cache implementation
REDIS_HOST=mem
REDIS_PASSWORD=

# Local file storage implementation
STORAGE_PROVIDER=local
LOCAL_STORAGE_URL=http://localhost:8099

I personally use docker-compose to load services dependencies (PostgreSQL, MongoDB, and Redis) and have a local Go compiler to run tests.

$ docker-compose -f docker-compose-unittest.yml up

If you are using the SQLite or Memory data provider with the Memory cache provider you'd have nothing to install. But sometimes, it's nice to run all tests against all supported options.

I use make to run tests, refer the the Makefile for the commands if you don't have make available.

$ make alltest

I often changes the DATA_STORE between pg and mongo. There's also specific make entry for all database providers.

Another I use often is the test-core, it test only the public API and does not test sub-packages.

$ make test-core

Submit Pull Requests

Here's how you'd submit changes you've made:

  1. Fork the repo
  2. Work on the main branch or create specifics branches on your repo.
  3. Push to your fork
  4. Create a pull request when you're ready

Some guideline:

  1. Make sure you have tests with your code changes
  2. Please add clear commit log messages
  3. Keep your commits scope isolated as much as possible
  4. When creating your pull request please be as detailed as you can

Code conventions

  1. We use tabs as indentation, mainly for accessibility reasons
  2. Please use the go format tool before committing your changes

Thanks