mirror of https://github.com/aldy505/code.git
docs: initialize
This commit is contained in:
parent
b13e6471a2
commit
378a4e7e2c
|
@ -0,0 +1,21 @@
|
|||
# Contributing Guide
|
||||
|
||||
Thank you for considering to contribute on this code base.
|
||||
|
||||
## Development Setup
|
||||
|
||||
* Node.js v14.17.0 (LTS)
|
||||
* Yarn v1.22.10 (or higher)
|
||||
* Install required dependency
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
* Start local development server
|
||||
```bash
|
||||
yarn dev
|
||||
```
|
||||
* Adhere to [commit convention](https://github.com/aldy505/code/blob/master/.github/COMMIT_CONVENTION.md) when you are writing a commit. Using [commitizen](https://commitizen.github.io/cz-cli/) is the recommended way.
|
||||
```bash
|
||||
git add .
|
||||
git cz
|
||||
```
|
|
@ -0,0 +1,21 @@
|
|||
# Code
|
||||
|
||||
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9d8edaee380a43bcb89a28222c34a4b0)](https://www.codacy.com/gh/aldy505/code/dashboard?utm_source=github.com&utm_medium=referral&utm_content=aldy505/code&utm_campaign=Badge_Grade) [![CodeFactor](https://www.codefactor.io/repository/github/aldy505/code/badge)](https://www.codefactor.io/repository/github/aldy505/code) [![Build](https://github.com/aldy505/code/actions/workflows/ci.yml/badge.svg)](https://github.com/aldy505/code/actions/workflows/ci.yml) [![GitHub license](https://img.shields.io/github/license/aldy505/code)](https://github.com/aldy505/code)
|
||||
|
||||
## License
|
||||
|
||||
Code is a codebase for code.reinaldyrafli.com
|
||||
Copyright (C) 2021-present Reinaldy Rafli
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
Loading…
Reference in New Issue