CONTRIBUTING.md

Contributing

Summary

• Requirements
• Issue
• Fork
• Installation
• Checkout
• Dependencies
• Resolution
• Tests
• Lint
• Clean (optional)
• Commit
• Push
• Pull request

Requirements

• Git
• Docker
• Docker Compose
• GNU/Make

⬆️ Go back to summary.

Issue

Choose an issue to resolve.

⬆️ Go back to summary.

Fork

See Fork a repo.

⬆️ Go back to summary.

Installation

$ git clone https://github.com/$USER/http.git ~/github.com/$USER/http
$ cd ~/github.com/$USER/http

Where $USER is your GitHub's username.

⬆️ Go back to summary.

Checkout

$ git checkout -b branch-name

Where branch-name is a relevant branch name related to the resolution of the issue.

⬆️ Go back to summary.

Dependencies

$ make          # short alias
$ make install  # long alias

⬆️ Go back to summary.

Resolution

Append changes until the issue is resolved.

⬆️ Go back to summary.

Tests

$ make test

⬆️ Go back to summary.

Lint

$ make lint

⬆️ Go back to summary.

Clean (optional)

This will remove all files listed in the .gitignore file.

$ make clean

⬆️ Go back to summary.

Commit

$ git commit --all --message "commit message"

Where commit message is a relevant commit message related to the resolution of the issue.

⬆️ Go back to summary.

Push

$ git push --set-upstream origin branch-name

⬆️ Go back to summary.

Pull request

See Creating a pull request.

⬆️ Go back to summary.