Skip to content
This repository was archived by the owner on Oct 17, 2020. It is now read-only.

Latest commit

 

History

History
208 lines (157 loc) · 5.45 KB

CONTRIBUTING.md

File metadata and controls

208 lines (157 loc) · 5.45 KB

How to contribute

I'm really glad you're reading this, thanks.

The following is a set of guidelines for contributing to shTTP. Use your best judgment, and feel free to propose changes to this document or any other community document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the shTTP Code of Conduct. Please report any unacceptable behavior to @gfarfanb.

Getting started

To start using this repository right away, fork this repository on GitHub.

How to install it

Windows approach

  • Check jq installation in command line by jq --version. If you do not have jq, download it from jq. Then setup Path environment variable in:
Windows > This PC > Properties > Advanced system settings > Environment Variables... > System variables

# Whatever location that makes sense
JQ_HOME=C:\dist\jq-[version]
Path=%Pah%; %JQ_HOME%

In order to use jq as command, is preferably to rename the executable jq-[win64 | win32].exe to jq.exe

  • Check installation jq --version, output must be similar to:
jq-[version]

Ubuntu approach

  • Check jq installation in command line by jq --version. If you do not have jq, install it by:
sudo apt-get update
sudo apt-get install jq
  • Check installation jq --version, output must be similar to:
jq-1.x-x-xxxxxxx
sudo apt-get install shellcheck

Usage:

shellcheck shttp
  • Service mock nginx:
sudo apt-get install nginx

Docker approach

Pull shTTP Docker image:

docker pull gfarfanb/shttp:[version]
docker image ls

Run container with downloaded image:

docker run -it -d -P --name [custom-container-name] -v [/local/shTTP/path]:/usr/src/app gfarfanb/shttp:[version]

Now you have access to enter the container:

docker ps -a
docker exec -it [container-id] bash

Useful links

Script plugin

Export execution permissions to script file:

git update-index --add --chmod=+x [script_file]

From source apply execution permissions:

sudo chmod +x [script_file]

Avoid errors because Windows-style '\r' line ending by:

sed -i 's/\r$//' [script_file]

Internal functions convention:

_name_of_internal_function() {
    :
}

Public function convention:

nameOfPublicFunction() {
    :
}

Conventions:

  1. Comments
    1. Spaces
    2. Identifiers: -param, -return, -test, -beforeTests, -afterTests, -author
    3. Identation

Testing execution

Execute Linter:

cd shTTP/ && ./lint

Execute Unit Tests:

# Execute all tests
cd shTTP/ && ./runtests

# Execute a test suite
cd shTTP/test/ && ./test_runner unit/[test-suite-name*]

test-suite-name: Name of the script file without prefix _test e.g. builder_test => builder

Execute Integration Tests (calling Gist API for shTTP Samples):

# Just samples execution
cd shTTP/ && ./runsamples $SAMPLE_USER $SAMPLE_PASSWORD

# Samples execution with Slack notifications
cd shTTP/ && ./runsamples $SAMPLE_USER $SAMPLE_PASSWORD $SLACK_SRV

SAMPLE_USER: GitHub username

SAMPLE_PASSWORD: GitHub password/personal access token

SLACK_SRV: Slack Incoming WebHook

How can I contribute in a different way?

Reporting bugs

  • Fill the required template.
  • Make sure you are correctly following the checklist section.
  • The description must be concise.
  • It is important the indicate environment you are testing.
  • Do not make support questions or comments, there are specific channels for this chat room or post discussion (at the end of posts).
  • Include screenshots and animated GIFs in your pull request whenever possible.

Suggesting enhancements

It is always welcome a new change idea, refactoring, design, features, new pages (not only posts), just propose it via feature requests or if consider better via pull requests.

Pull Requests

  • Fill the required template.
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Describe every change you made in a new bullet.
  • End all files with a newline.
  • Do not forget to list the contributors.
  • Every pull request must have one review, must be up to date and must have verified signatures, so wait and process the feeback.

Once your pull request is ready to be merged, the repository maintainers will integrate it. There is no additional action required from pull request contributors at this point.

Copyright

shTTP core is licensed under MIT License, with a few exceptions in bundled classes. We consider all contributions as MIT unless it's explicitly stated otherwise. MIT-incompatible code contributions will be rejected. Contributions under MIT-compatible licenses may be also rejected if they are not ultimately necessary.