Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

51 lines (40 loc) · 1.7 KB
Raw

Table of Contents

Development contributions

Before submitting a change to the code:

  • Run tests to make sure that the existing ones work
  • If possible add new tests concerning the new feature

Screenshot of the tests

Run tests

To run all the defined tests:

shellspec --format d --jobs 3

Installing Shellspec

Make sure to have Git installed, then install Shellspec

bash <(curl -fsSL https://git.io/shellspec) 0.28.1 --prefix ~/.local

Screenshot of the installation process

Side note

When installing Spellspec on Cygwin make sure to have Git installed as a Cygwin package, since using the Windows version will break the installation process.

After this, you'll be able to find the binary file under ~/.local/bin. Now we just need to add this folder to the PATH environment variable to make the shellspec binary always available.

This can be achieved by adding this command to ~/.bash_profile if using Bash or ~/.profile otherwise.

  • Bash: 
     echo 'PATH=~/.local/bin:$PATH' >> ~/.bash_profile
  • Other shells: 
     echo 'PATH=~/.local/bin:$PATH' >> ~/.profile