Contributing to Oasis

Getting Started

Oasis is actively open to new contributions. If you would like to contribute, follow the instructions for the package(s) you are looking to set up in docs/packages. We highly recommend taking a look at our issues for anything interesting that may seem fitting for you to work on before deciding to add any new features.

We also have a public roadmap, that can be viewable for everyone.

Commit Messages

Oasis is following the cz-conventional-changelog standard for commit messages.

1. Run yarn in the project root
2. Add the files you want to commit with git add [files]
3. Run yarn commit in the project root for a interactive prompt to appear and follow the instructions.

Environment Variables

Follow the environment variable examples (located in .env.example) for web and api, to fill in your own .env file.
Reminder: Not all of the environment variables are required.

Running Scripts

# Install all dependencies
$ yarn

# Build Packages
$ yarn build:dev

# Build a specific package
$ yarn build <package>

# Run the Web Application and UI Components
$ yarn dev

# Delete all compiled code globally
$ yarn clean

Linting

# Run Prettier
$ yarn fix:prettier

# Run Eslint
$ yarn fix:lint

Translations

You can view translations in the locales folder.
To add a new translation, make a new folder in the locales directory, create an index.ts file and add it to the index file.

We are always open to making Oasis more accessible by adding languages.