First of all, thanks for thinking about contributing. Hopefully the following guidelines will help you contributing. If you got any questions, do add a issue with your questions and we will try to help.
This is a fairly small project. IMO, the ideal size for getting started with electron.
Just fork the repo and dive in. The app/index.js is the starting of all the application.
Once changes are made, just do a pull request in a branch of develop.
Each subfolder has a README.md file that explains the reason of existence and any extra required information.
To run this application from source, you will need yarn installed.
Please refer to the yarn installation page
To run the application from source:
yarn startWe are using electron-build in conbination with travis-ci to create our build files.
If you want to generate the build locally, you can run the following command:
yarn run dist:linuxIf you want to use a node container to create your packages, use this command: (docker user should replace podman by docker)
podman run -it --rm --volume .:/var/mnt:z -w /var/mnt/ node:14 /bin/bash -c "apt update && apt install -y rpm && yarn install && yarn run dist:linux"This will build an deb, rpm, snap, AppImage and tar.gz files in the dist folder. This files can be run in most popular linux distributions.
Is possible to specify the snap or AppImage build type using running this:
# Standalone build
yarn run dist:linux:snap
# Or, if you have docker installed, you can alternatively build there
./dockerBuildSnap.shThis will build the snap into the dist/ directory.
To install the snap file using the generated file use this command.
cd dist
sudo snap install teams-for-linux_VERSION_amd64.snap --dangeroussudo snap install teams-for-linuxWe are following SemVer at the moment. The lower number in develop will be increased after a release.
Decide the release number before merging to develop following SemVer.