Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

72 lines (43 loc) · 2.05 KB

Contributing

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.

Development

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 to develop.

Each subfolder has a README.md file that explains the reason of existence and any extra required information.

Pre-requisites

To run this application from source, you will need yarn installed.

Please refer to the yarn installation page

Run from source

To run the application from source:

yarn start

Build for linux

We 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: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.

Snap build

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.sh

This will build the snap into the dist/ directory.

Install using locally built snap file

To install the snap file using the generated file use this command.

cd dist
sudo snap install teams-for-linux_VERSION_amd64.snap --dangerous

Install using snap from store

sudo snap install teams-for-linux

Version number

We are following SemVer at the moment. The lower number in master will be increased after a release (basically, to avoid re-releasing stuff with some changes), but release number will be decided just before a release trying to use SemVer standards.