algolia-samples / about

Welcome to Algolia Samples! πŸ‘‹
https://www.Algolia.com
MIT License
2 stars 1 forks source link
algolia

Algolia Samples - Open source samples by Algolia & the Community

What are Algolia Samples?

Algolia Samples hosts the samples developed by the people at Algolia and the community.

Feel free to submit issues, fixes, or suggestions to improvements for the samples.

πŸš€ Let's build awesome things together πŸš€

About this repository

This repository is a place to:

  1. Submit a request to have your own sample added to algolia-samples
  2. Learn about our sample application & templates coding guidelines

Contributing to Algolia Samples

We built Algolia Samples for the community and we welcome any contributions.

There are different ways you can contribute:

1. Add functionalities or fix issues for existing samples

Every sample on Algolia Samples is open source and welcomes contributions. Make sure to read the README.md, the CONTRIBUTING.md (if available) and eventual open issues before getting started.

2. Add your own sample

If you already have a sample or planning to build one, we will be happy to host and feature it on Algolia Samples. Please follow the steps below to do so:

  1. πŸ› οΈ Start to build your sample (if you haven't already!)
  2. πŸ€“ Take a look at our coding guidelines. We don't ask you to follow every point of them, but since those are followed for Algolia's samples, we think it's still important to offer a coherent experience.
  3. πŸ–ŠοΈ Once your application is ready, let us know!
  4. πŸ’™ We will get back to you as soon as possible with any questions we might have or a way to publish your sample on Algolia Samples.

Code of Conduct

Your safety and comfort are important to us. The Code of Conduct lets everyone know what’s expected, so we can do a better job of interacting with one another. All contributions to and interactions with Algolia's samples have to adhere to our Code of Conduct. You can report violations at samples@algolia.com.