130 lines
No EOL
4.1 KiB
Markdown
130 lines
No EOL
4.1 KiB
Markdown
Hi (future) collaborator!
|
|
|
|
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
**Table of Contents**
|
|
|
|
- [Where to start?](#where-to-start)
|
|
- [Development workflow](#development-workflow)
|
|
- [Requirements](#requirements)
|
|
- [Launch](#launch)
|
|
- [Local build](#local-build)
|
|
- [Commit message guidelines](#commit-message-guidelines)
|
|
- [Revert](#revert)
|
|
- [Type](#type)
|
|
- [Scope](#scope)
|
|
- [Subject](#subject)
|
|
- [Body](#body)
|
|
- [Footer](#footer)
|
|
- [Releasing](#releasing)
|
|
|
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
|
|
# Where to start?
|
|
|
|
Have a fix or a new feature? [Search for corresponding issues](https://github.com/algolia/docsearch/issues) first then create a new one.
|
|
|
|
# Development workflow
|
|
|
|
## Requirements
|
|
|
|
To run this project, you will need:
|
|
|
|
- Node.js >= v8.7.0, use nvm - [install instructions](https://github.com/creationix/nvm#install-script)
|
|
- [Ruby](https://www.ruby-lang.org/en/)
|
|
- [Bundler](http://bundler.io/)
|
|
|
|
## Launch
|
|
|
|
```sh
|
|
npm install
|
|
npm run dev:docs
|
|
```
|
|
|
|
Then go to:
|
|
- http://localhost:4000/docsearch/ documentation website with autoreload
|
|
- http://localhost:8080 local DocSearch example for easy hacking/additions/fixes
|
|
|
|
## Local build
|
|
|
|
You might want to expose a local build to the outside to test things on real
|
|
websites. To do so:
|
|
|
|
```sh
|
|
npm run serve
|
|
```
|
|
|
|
Then files will be available at http://localhost:8080. Use [ngrok](https://ngrok.com/download) to
|
|
then expose your build to the web.
|
|
|
|
# Commit message guidelines
|
|
|
|
We use [conventional changelog](https://github.com/ajoslin/conventional-changelog) to generate our changelog from our git commit messages.
|
|
|
|
Here are the rules to write commit messages, they are the same than [angular/angular.js](https://github.com/angular/angular.js/blob/7c792f4cc99515ac27ed317e0e35e40940b3a400/CONTRIBUTING.md#commit-message-format).
|
|
|
|
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
|
|
format that includes a **type**, a **scope** and a **subject**:
|
|
|
|
```text
|
|
<type>(<scope>): <subject>
|
|
<BLANK LINE>
|
|
<body>
|
|
<BLANK LINE>
|
|
<footer>
|
|
```
|
|
|
|
The **header** is mandatory and the **scope** of the header is optional.
|
|
|
|
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
|
|
to read on GitHub as well as in various git tools.
|
|
|
|
## Revert
|
|
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
|
|
|
|
## Type
|
|
Must be one of the following:
|
|
|
|
* **feat**: A new feature
|
|
* **fix**: A bug fix
|
|
* **docs**: Documentation only changes
|
|
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
|
|
semi-colons, etc)
|
|
* **refactor**: A code change that neither fixes a bug nor adds a feature
|
|
* **perf**: A code change that improves performance
|
|
* **test**: Adding missing tests
|
|
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
|
|
generation
|
|
|
|
## Scope
|
|
The scope could be anything specifying place of the commit change. For example `RefinementList`,
|
|
`refinementList`, `rangeSlider`, `CI`, `url`, `build` etc...
|
|
|
|
## Subject
|
|
The subject contains succinct description of the change:
|
|
|
|
* use the imperative, present tense: "change" not "changed" nor "changes"
|
|
* don't capitalize first letter
|
|
* no dot (.) at the end
|
|
|
|
## Body
|
|
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
|
|
The body should include the motivation for the change and contrast this with previous behavior.
|
|
|
|
## Footer
|
|
The footer should contain any information about **Breaking Changes** and is also the place to
|
|
reference GitHub issues that this commit **Closes**.
|
|
|
|
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
|
|
|
|
# Releasing
|
|
|
|
If you are a maintainer, you can release.
|
|
|
|
We use [semver](http://semver-ftw.org/).
|
|
|
|
You must be on the master branch.
|
|
|
|
```sh
|
|
npm run release
|
|
``` |