Welcome to mirror list, hosted at ThFree Co, Russian Federation.

CONTRIBUTING.md « .github - github.com/kakawait/hugo-tranquilpeak-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 8043181f58871b2656e64da6d1fca0bb76775e62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# Contributing

All kinds of contributions (enhancements, new features, documentation & code improvements, issues & bugs reporting) are welcome.

## Code style

### Javascript

We use [ESLint](http://eslint.org) based on Google code style to maintain code style.
Check code status with:

``` bash
npm run lint
```

## Issues

When you create an issue to report a bug or ask a question, please fill template information, except if is **really not relevant**. And all others related information that are susceptible to help us.

## Pull requests

All pull requests must be done on the **develop** branch.

Before a pull request :

 - There is no tests yet so verify that your code is running well. Blog generation (`hugo`) must not outputs errors
 - Check code style with eslint.
 - Don't forget to update user and/or developer documentation if it's necessary