Skip to content

Latest commit

 

History

History
151 lines (105 loc) · 5.23 KB

CONTRIBUTING.md

File metadata and controls

151 lines (105 loc) · 5.23 KB
Raw

Contributing to bashunit

We have a Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Any contributions you make will be under the MIT License

When you submit code changes, your submissions are understood to be under the same MIT that covers the project. By contributing to this project, you agree that your contributions will be licensed under its MIT.

Write bug reports with detail, background, and sample code

In your bug report, please provide the following:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Please post code and output as text (using proper markup). Additional screenshots to help contextualize behavior are ok.

Workflow for Pull Requests

  1. Fork/clone the repository.
  2. Create your branch from main if you plan to implement new functionality or change existing code significantly.
  3. Implement your change and add tests for it.
  4. Ensure the test suite passes.
  5. Ensure the code complies with our coding guidelines (see below).
  6. Send that pull request!

Please make sure you have set up your username and email address for use with Git. Strings such as silly nick name <root@localhost> looks bad in the commit history of a project.

Specific set up for documentation application

Our documentation is build with VitePress, for set up a local environment to contribute follow these steps:

  1. You'll need node (we recommend using nvm) and npm for set up the environment.
    • Using nvm you can execute nvm use(reads .nvmrc file) in the project root directory and follow the instructions to use the correct node version.
  2. Install dependencies with npm ci.
  3. Run local development server with npm run docs:dev.
  4. Implement your changes.
  5. Before submitting your Pull Request run npm run docs:build to ensure everything works.

Change the configuration

To change the configuration for the project we use the .env file if you would like to know what variables should be there use the following command:

cp .env.example .env

Testing

Run tests from the library:

# using make
make test

# using bashunit itself
./bashunit tests/**/*_test.sh

Run the test with a watcher for development: this will require to have installed fswatcher

# you have to install `watch` for your OS
make test/watch

Testing different OS

  • Linux
    • Ubuntu latest
    • Alpine latest
  • Windows latest
  • MacOS latest

Docker

Ubuntu latest
docker run --rm -it -v "$(pwd)":/project -w /project ubuntu:latest \
    sh -c  "apt-get update && \
            apt-get install -y bash make shellcheck git curl perl && make test"
Alpine latest
make test/alpine
# or
docker run --rm -it -v "$(pwd)":/project -w /project alpine:latest \
    sh -c  "apk add bash make shellcheck git && make test"

Coding Guidelines

ShellCheck

To contribute to this repository you must have ShellCheck installed on your local machine or IDE, since it is the static code analyzer that is being used in continuous integration pipelines.

Installation: https://github.com/koalaman/shellcheck#installing

Example of usage

# using make
make sa

# using ShellCheck itself
shellcheck ./**/**/*.sh -C

editorconfig-checker

To contribute to this repository, consider installing editorconfig-checker to check all project files regarding the .editorconfig to ensure we all fulfill the standard.

Installation: https://github.com/editorconfig-checker/editorconfig-checker#installation

To run it, use the following command:

# using make
make lint

# using editorconfig-checker itself
ec -config .editorconfig

This command will be executed on the CI to ensure the project's quality standards.

We recommend

To install the pre-commit of the project with the following command:

Please note that you will need to have ShellCheck and editorconfig-checker installed on your computer. See above how to install in your local.

make pre_commit/install

Shell Guide by Google Conventions.

Documentation

For us the documentation it's really important, we are a small group, and we want to maintain this project for long, to do that we will need your help.

ADR

If you want to change something related to the architecture or apply a change that it's a decision on how the library works please use ADR otherwise we will request you to do so on the PR.