Skip to content

Latest commit

 

History

History
109 lines (73 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

109 lines (73 loc) · 3.05 KB

Contributing

Thank you for contributing to this project! This page describes how to setup the project on your computer for local development.

The Five Golden Rules

The simple steps of contributing to any GitHub project are as follows:

  • Fork the repository
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git commit -am 'Add some feature'
  • Push to the branch: git push -u origin my-new-feature
  • Create a Pull Request

To keep your fork of in sync with this repository, follow this guide.

For contributors with at least Write access to this repository, you can directly clone, push branches, and create a pull request from this repository.

Prerequisites

Windows, macOS and Linux

  • Git
  • Node.js (16.0.0+)
  • Yarn (1.x)
  • Text Editor with EditorConfig & Prettier support. (We recommend Visual Studio Code)

Prerequisite Check

Run these commands inside the Terminal (PowerShell/Command Prompt for Windows).

Git: You should see the version number:

$ git version
git version 2.35.1.windows.2

Node.js: You should see the version number:

$ node -v
v16.13.0

Yarn: You should see the version number:

$ yarn -v
1.22.18

Make sure to run

yarn

Setting Up

First, you should clone the repository that you forked.

$ git clone https://github.com/[your_username]/warung-config.git

For example:

$ git clone https://github.com/resir014/warung-config.git

After this repository has been cloned, cd into the repository:

$ cd warung-config

Install the project's dependencies. Note that we use Yarn, not npm:

$ yarn

Developing

To start developing components, open the project in your favourite text editor. (e.g. Visual Studio Code)

$ code .

Commit messages and Pull Request titles

We are following Conventional Commits guidelines to determine semantic version and changelog auto generation. Currently, the presets that we use is angular.

Type

Should be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: docker, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: gitlab-ci, bash scripts)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests