From 0a76913f15bb9c4974aea267508e6f4b6a734d77 Mon Sep 17 00:00:00 2001 From: Vincent Voyer Date: Tue, 4 Apr 2017 18:59:26 +0200 Subject: [PATCH] docs(react-instantsearch): remove mentions of ris (#2094) Since we moved react-instantsearch to https://github.com/algolia/react-instantsearch/ and https://community.algolia.com/react-instantsearch/ We can now remove mentions of the old repo organisation along with old release scripts and specifics --- .github/ISSUE_TEMPLATE.md | 44 ++++++-- CONTRIBUTING.md | 219 +++++--------------------------------- LICENSE | 3 +- README.md | 215 +++---------------------------------- docs/_config.yml | 2 +- docs/documentation.md | 2 +- docs/index.haml | 2 +- scripts/docs/gh-pages.js | 3 +- 8 files changed, 82 insertions(+), 408 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index ef6bde4a16..3046736301 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,16 +1,44 @@ **Do you want to request a *feature* or report a *bug*?** -**What is the current behavior?** + + +**Bug: What is the current behavior?** + +**Bug: What is the expected behavior?** + +**Bug: What browsers are impacted? Which versions?** + +**Feature: What is your use case for such a feature?** + +**Feature: What is your proposed API entry? The new option to add? What is the behavior?** -**If the current behavior is a bug, please provide all the steps to reproduce and a minimal -[JSFiddle](https://jsfiddle.net/) example or a repository on GitHub that we can `npm install` -and `npm start`.** +**What is the version you are using? Always use the latest one before opening a bug issue.** -**What is the expected behavior?** + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed89b05098..6f14957b3b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,225 +1,56 @@ -Hi (future) collaborator! +[![InstantSearch.js logo][logo]][website] -**tl;dr;** -- submit pull requests to develop branch -- use conventional changelog commit style messages -- squash your commits -- have fun +## Development - - -**Table of Contents** - -- [Where to start?](#where-to-start) -- [New API proposal](#new-api-proposal) -- [How to write issues](#how-to-write-issues) -- [Development workflow](#development-workflow) -- [Serving the build](#serving-the-build) -- [Commit message guidelines](#commit-message-guidelines) - - [Revert](#revert) - - [Type](#type) - - [Scope](#scope) - - [Subject](#subject) - - [Body](#body) - - [Footer](#footer) -- [Squash your commits](#squash-your-commits) -- [When are issues closed?](#when-are-issues-closed) -- [Milestones](#milestones) -- [Releasing](#releasing) -- [Hotfixes](#hotfixes) - - [Releasing hotfixes](#releasing-hotfixes) - - [Documentation updates](#documentation-updates) - - - -# Where to start? - -Have a fix or a new feature? [Search for corresponding issues](https://github.com/algolia/instantsearch.js/issues) first then create a new one. - -Always check the status of the [develop branch](https://github.com/algolia/instantsearch.js/tree/develop) for the freshest code. - -Always submit pull requests to the develop branch. - -**Wanna help us?** All issues belonging to the [`next` milestone](https://github.com/algolia/instantsearch.js/milestones/next) can be worked on. - -# New API proposal - -If you have a new **API proposal** or change, create an issue describing it precisely: -- JavaScript API example -- Resulting DOM/effect - -Here's an example: [New widget: hitsPerPageSelector (#331)](https://github.com/algolia/instantsearch.js/issues/331). +```sh +yarn +yarn dev:docs +``` -# How to write issues +Go to for the example playground. -Start with some context, when and/or where you encountered the issue. +Go to for the documentation website. -Since instantsearch.js is a UI library, if your issue is UI related then adding a screenshot or (better) a GIF will make your issue a lot easier to understand. +## Code -# Development workflow +The code for InstantSearch.js is located in [src](src). -Requirements: -- [Node.js](https://nodejs.org/) -- [yarn](https://yarnpkg.com/en/docs/install) -- [Ruby](https://www.ruby-lang.org/en/) -- [Bundler](http://bundler.io/) +## Test -Run the local example: +We have unit tests written with [Jest](https://facebook.github.io/jest/): +Single run and linting: ```sh -npm run dev -# open http://localhost:8080 -# make changes in your widgets, or in example/app.js +yarn test ``` -Run local example and docs: - +Watch mode: ```sh -npm run dev:docs -# open http://localhost:4000/ +yarn test:watch # unit tests watch mode, no lint ``` -Run tests and lint: +## Lint ```sh -npm test -``` - -# Serving the build - -For some use cases like building a demo, you may want to serve the current build -on an http endpoint. - -To do so: - -```sh -npm run serve -``` - -Will build, watch for changes and serve instantsearch.css and instantsearch.js on http://localhost:8080. - -# Commit message guidelines - -We use [conventional changelog](https://github.com/ajoslin/conventional-changelog) to generate our changelog from our git commit messages. - -**Some examples**: -- feat(rangeSlider): add new range option to the rangeSlider -- fix(refinementList): send the full algolia result to the noResults template - -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 -(): - - - -