global19-atlassian-net / opensource

Open source monorepo by BRIKL

opensource

Open source monorepo by BRIKL

Developing or debugging

This repository is using structure from Nx, please make sure you have the following prerequisites:

• You installed the long-term support (LTS) version of Node
• You have yarn installed in your machine
• You have Nx CLI installed (docs)
• When working with the codebase, we recommend using an IDE with intelligent code completion and syntax highlighting, such as Visual Studio Code or JetBrains WebStorm.

Downloading the source code

git clone https://github.com/Brikl/opensource.git brikl-opensource
cd brikl-opensource

To update the source code to the latest commit, run the following command inside the brikl-opensource directory:

git pull

Developing

We are focusing on keeping every applications and libraries to be type-strict as much as possible, so every file must be written in TypeScript as much as possible.

If you're using Visual Studio Code, we already prepared some recommended extensions for you.

Code analysis

Before committing your code, please run a code formatter. This can be checked by running nx lint <project> in the command line.

Contributing

When it comes to contributing to the project, the two main things you can do to help out are reporting issues and submitting pull requests. Based on past experiences, we have prepared a list of contributing guidelines that should hopefully ease you into our collaboration process and answer the most frequently-asked questions.

Note that while we already have certain standards in place, nothing is set in stone. If you have an issue with the way code is structured, with any libraries we are using, or with any processes involved with contributing, please bring it up. We welcome all feedback so we can make contributing to this project as painless as possible.

Licence

All libraries and apps in this repository are licensed under the MIT licence. Please see the licence file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.