Skip to content

Commit 5cf53df

Browse files
dhayabsarahdayan
dhayab
and
sarahdayan
authored
chore: update readme and add contributing guidelines
Co-authored-by: Sarah Dayan <[email protected]>
1 parent fdb8d8c commit 5cf53df

File tree

5 files changed

+178
-10
lines changed

5 files changed

+178
-10
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE/Bug_report.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Help us improve Unified InstantSearch for Ecommerce
4+
---
5+
6+
## 🐛 Bug description
7+
8+
<!-- A clear and concise description of what the bug is. -->
9+
10+
## 🔍 Bug reproduction
11+
12+
**Steps to reproduce the behavior:**
13+
14+
1. Go to `...`
15+
2. Click on `...`
16+
3. Scroll down to `...`
17+
4. See error
18+
19+
## 💭 Expected behavior
20+
21+
<!-- A clear and concise description of what you expected to happen. -->
22+
23+
## 🖥 Screenshots
24+
25+
<!-- If applicable, add screenshots to help explain your problem. -->
26+
27+
## Environment
28+
29+
- OS: [e.g. Windows / Linux / macOS / iOS / Android]
30+
- Browser: [e.g. Chrome, Safari]
31+
- Version: [e.g. 22]
32+
33+
## Additional context
34+
35+
<!-- Add any other context about the problem here. -->

Diff for: ‎.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Feature Request
4+
url: https://github.com/algolia/unified-instantsearch-ecommerce/issues/new?title=Feature%20request%3A
5+
about: Request a feature to add to Unified InstantSearch.
6+
- name: Ask a Question
7+
url: https://github.com/algolia/unified-instantsearch-ecommerce/issues/new
8+
about: Ask questions and discuss with other community members.

Diff for: ‎.github/unified-instantsearch-ecommerce.png

-87.3 KB
Loading

Diff for: ‎CONTRIBUTING.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Contributing to Unified InstantSearch for Ecommerce
2+
3+
Welcome to the contributing guide for Unified InstantSearch for Ecommerce!
4+
5+
If this guide does not contain what you are looking for and thus prevents you from contributing, don't hesitate to [let us know](https://github.com/algolia/unified-instantsearch-ecommerce/issues/new).
6+
7+
## Reporting an issue
8+
9+
Opening an issue is very effective way to contribute because many users might also be impacted. We'll make sure to fix it quickly if it's technically feasible and doesn't have important side effects for other users.
10+
11+
Before reporting an issue, first check that there is not an already open issue for the same topic using the [issues page](https://github.com/algolia/unified-instantsearch-ecommerce/issues). Don't hesitate to thumb up an issue that corresponds to the problem you have.
12+
13+
Another element that will help us go faster at solving the issue is to provide a reproducible test case.
14+
15+
## Code contribution
16+
17+
For any code contribution, you need to:
18+
19+
- Make sure that the code change has been discussed in [Issues](https://github.com/algolia/unified-instantsearch-ecommerce/issues)
20+
- Fork and clone the project
21+
- Create a new branch for what you want to solve ("fix/<u>issue-number</u>", "feat/<u>name-of-the-feature</u>")
22+
- Make your changes
23+
- Open a pull request
24+
25+
Then:
26+
27+
- A team member will review the pull request
28+
29+
When every check is green and a team member approves, your contribution is merged! 🚀
30+
31+
## Commit conventions
32+
33+
This project follows the [conventional changelog](https://conventionalcommits.org/) approach. This means that all commit messages should be formatted using the following scheme:
34+
35+
```
36+
type(scope): description
37+
```
38+
39+
This convention is used to generate the [changelog](https://github.com/algolia/unified-instantsearch-ecommerce/tree/master/CHANGELOG.md).
40+
41+
In most cases, we use the following types:
42+
43+
- `fix`: for any resolution of an issue (identified or not)
44+
- `feat`: for any new feature
45+
- `refactor`: for any code change that neither adds a feature nor fixes an issue
46+
- `docs`: for any documentation change or addition
47+
- `chore`: for anything that is not related to the library itself (e.g., doc, tooling)
48+
49+
Even though the scope is optional, we try to fill it in as it helps us better understand the impact of a change.
50+
51+
Finally, if your work is based on an issue on GitHub, please add in the body of the commit message "Closes #1234" if it solves the issue #1234 (read "[Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords)").
52+
53+
Some examples of valid commit messages (used as first lines):
54+
55+
> - fix(js): increase magnifying glass size
56+
> - feat(core): add `enterKeyHint` input prop
57+
> - refactor(core): inline `navigator` default prop
58+
> - docs(state): add `query` state property
59+
> - docs(readme): add "Showcase" section
60+
> - chore(deps): update dependency rollup-plugin-babel to v3.0.7
61+
62+
## Installation
63+
64+
### Requirements
65+
66+
To run this project, you will need:
67+
68+
- Node.js ([nvm](https://github.com/creationix/nvm#install-script) is recommended)
69+
- [Yarn](https://yarnpkg.com)
70+
71+
### Launch the dev environment
72+
73+
```sh
74+
yarn
75+
yarn start
76+
```
77+
78+
Go to http://localhost:3000 to open the app. You should see a website with a search bar in the top-right corner.
79+
80+
## Release
81+
82+
```sh
83+
yarn run release
84+
```
85+
86+
It will create a pull request for the next release. When it's reviewed, approved and merged, then CircleCI will automatically publish the packages to npm.

Diff for: ‎README.md

+49-10
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,60 @@
1-
# Unified InstantSearch E-Commerce
1+
<div align="center">
2+
<h1>Unified InstantSearch for Ecommerce</h1>
3+
<p><strong>A ready-to-use, fully functional Search & Discovery UI on top of InstantSearch</strong></p>
4+
</div>
25

3-
<p align="center">
4-
<a href="https://www.algolia.com/doc/guides/building-search-ui/resources/unified-instantsearch/react/"><img src="./.github/unified-instantsearch-ecommerce.png" alt="Unified InstantSearch E-Commerce" width="1280" /></a>
5-
</p>
6+
---
67

7-
**This project aims to be used by any e-commerce website to bootstrap a search experience powered by Algolia the fastest way possible.**
8+
Build your Ecommerce Search & Discovery experience in no time using this framework-agnostic prebuilt UI that offers out-of-the-box a robust as-you-type InstantSearch experience, while retaining the customizability of [Algolia InstantSearch](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/).
89

9-
While you would still have to push your data to Algolia, the goal of Unified InstantSearch E-Commerce is to remove the need to implement front-end logic and be able to start using Algolia as quickly as possible.
10+
Designed to accelerate your Algolia integration, this mobile-optimised UI has been created to best fit any website UI via its full page overlay and offers a direct access to the following Algolia key features:
11+
12+
- Typo proof as-you-type InstantSearch experience
13+
- Query Suggestions
14+
- Advanced Analytics with A/B testing
15+
- Dynamic Re-ranking
16+
- Personalization
17+
- Merchandising capabilities, including banners via Rules
18+
19+
On the frontend side, once compiled, the total package weighs under 300kb and runs on any existing website, regardless of the framework used (see [Browser support](#browser-support)). Its impact on Core Vitals is almost transparent.
20+
21+
#### [**See Live Demo ↗**](https://unified-instantsearch-ecommerce.netlify.app)
22+
23+
<a href="https://unified-instantsearch-ecommerce.netlify.app" target="_blank">
24+
<img src="./.github/unified-instantsearch-ecommerce.png" alt="Unified InstantSearch for Ecommerce" width="1280" />
25+
</a>
1026

1127
## Documentation
1228

13-
To get started with Unified InstantSearch E-Commerce, head over to the [wiki](https://github.com/algolia/unified-instantsearch-ecommerce/wiki).
29+
The [documentation](https://www.algolia.com/doc/guides/building-search-ui/resources/unified-instantsearch/react/) offers a few ways to learn about Unified InstantSearch for Ecommerce:
30+
31+
- Read the [Getting Started](https://www.algolia.com/doc/guides/building-search-ui/resources/unified-instantsearch/tutorials/getting-started/react/) tutorial to setup your local version of Unified InstantSearch and integrate it into your website
32+
- Find out how to [Use Your Own Data](https://www.algolia.com/doc/guides/building-search-ui/resources/unified-instantsearch/tutorials/using-your-own-data/react/) by formatting it specifically for Unified InstantSearch and pushing it to Algolia
33+
- Learn how to [Customize the UI](https://www.algolia.com/doc/guides/building-search-ui/resources/unified-instantsearch/tutorials/customizing-your-ui/react/) to make it blend with your website's branding
34+
- Setup advanced [Merchandising and Rules](https://www.algolia.com/doc/guides/building-search-ui/resources/unified-instantsearch/tutorials/merchandising-and-rules/react/) to promote items and add banners
35+
36+
You can also go to the wiki to access the full [Configuration options](https://github.com/algolia/unified-instantsearch-ecommerce/wiki/Configuration-options) reference.
1437

1538
## Disclaimer
1639

17-
> Unified InstantSearch E-Commerce is made accessible to you for trial and experimentation purposes. You may decide to use it or not. You are aware that the use of Unified InstantSearch E-Commerce in production may increase your consumption of the Service, including [Queries Per Second](https://www.algolia.com/doc/faq/monitoring/which-queries-are-counted-as-part-of-the-max-qps-computations/).
40+
> Unified InstantSearch for Ecommerce is made accessible to you for trial and experimentation purposes. You may decide to use it or not. You are aware that the use of Unified InstantSearch for Ecommerce in production may increase your consumption of the Service, including [Queries Per Second](https://www.algolia.com/doc/faq/monitoring/which-queries-are-counted-as-part-of-the-max-qps-computations/).
41+
>
42+
> Unified InstantSearch for Ecommerce source code is provided "as is" and "as available" without any support or warranty of any kind. For purposes of our [SLA](https://www.algolia.com/policies/sla), the Unified InstantSearch for Ecommerce is not an "API Client".
43+
44+
## Browser support
45+
46+
Unified InstantSearch for Ecommerce supports the **last two versions of the major browsers** (Chrome, Edge, Firefox, Safari) as well as Internet Explorer 11.
47+
48+
## How to contribute
49+
50+
We welcome all contributors, from casual to regular :blue_heart:. See [CONTRIBUTING](CONTRIBUTING.md) for more information about the contribution process.
51+
52+
- **Bug report**. Is something not working as expected? [Send a bug report](https://github.com/algolia/unified-instantsearch-ecommerce/issues/new?template=Bug_report.md).
53+
- **Feature request.** Would you like to add something? [Send a feature request](https://github.com/algolia/unified-instantsearch-ecommerce/issues/new?title=Feature%20request%3A).
54+
- **Documentation.** Did you find a typo in the doc? [Open an issue](https://github.com/algolia/unified-instantsearch-ecommerce/issues/new).
55+
56+
See [Installation](CONTRIBUTING.md#installation) for instructions on how to install the project.
1857

19-
> Algolia does not support Unified InstantSearch E-Commerce, and may discontinue it at any time at its sole discretion; configurations and customizations entered by you into Unified InstantSearch E-Commerce may be permanently lost. Any feedback (including source code) you may provide to us regarding Unified InstantSearch E-Commerce may be used by Algolia to improve the Service.
58+
## License
2059

21-
> Unified InstantSearch E-Commerce source code is provided "as is" and "as available" without any warranty of any kind. Algolia disclaims all obligation and liability for any harm or damage arising out of or in connection with Unified InstantSearch E-Commerce. For purposes of our [SLA](https://www.algolia.com/policies/sla), the Unified InstantSearch E-Commerce is not an "API Client".
60+
Unified InstantSearch for Ecommerce is [Apache-2.0 licensed](LICENSE).

0 commit comments

Comments
 (0)