Skip to content

Latest commit

 

History

History
118 lines (86 loc) · 4.7 KB

CONTRIBUTING.md

File metadata and controls

118 lines (86 loc) · 4.7 KB
Raw

Contributing

We love pull requests from everyone. By participating in this project, you agree to abide by Code of Conduct.

Code contributions

Setup

Run the following to get started:

git clone https://github.com/wslutilities/wslu
git checkout develop
git submodule init
git submodule update
./configure.sh -a
make
sudo make link

Build Structure

wslu
|-src
|  |-mime/wslview: mime file for wslview
|  |-etc
|  |  |-wsl.ico: default icon for wslusc
|  |  \-runHidden.vbs: script for wslusc
|  |-wslu-header: Header file of all script
|  \-<components>.sh: Components of script
|-tests: location for script tests
\-extras
   |-bats: testing utility
   |-scripts: scripts used for building
   \-build
      |-debian: files for building .deb
      |-rpm: files for building .rpm
      |-arch: files for building Arch Linux packages
      \-alpine: files for building Alpine Linux packages

configure.sh

configure.sh is the script to complete some preprocessing task. Following parameter is available:

  • -e, --env -- Environment Check, check whether it is using Fake WSL Environment, normal Linux or WSL.
  • -p, --prsh -- Check Status of powershell.exe.
  • -P, --pkg -- Install Needed Packages required by your system for building.
  • -a, --all -- Do everything at the top.

Build & Install

run make to build executable to out folder. run make clean to clean out folder. run make test to run tests. run make install to install to /usr/bin/. Requires to run as sudo. run make link to link files from the repo to /usr/bin/. Requires to run as sudo. run make uninstall to uninstall. Requires to run as sudo. run cd extras/scripts && ./builder-docs.sh to build docs to gendocs.

Test

wslu use bats for testing. Please refer to its guide to write tests.

Build Packages

For Debian Package, run:

cd extras/script
sudo ./builder-deb.sh

For RPM Package, run:

cd extras/script
sudo ./builder-rpm.sh

It is suggested to execute those commands in Ubuntu 16.04 LTS or its corresponding environment.

Push Requests

Make sure that the code changed is tested.

Then create Pull requests here.

Financial contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

Contributors

Thank you to all the people who have already contributed to wslu!

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)