-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CONTRIBUTING.md fixes and improvements
- Loading branch information
Showing
1 changed file
with
7 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,33 @@ | ||
# Contribute | ||
|
||
we are pretty gald to have you to participate, any contributions is welcome, including the documentations and tests. | ||
you can do the `Pull Requests`, `Issue` on the github, and we will review it as soon as possible. | ||
We are glad to have you participate. Any contributions are welcome, including documentations and tests. | ||
You can create a `Pull Request` or `Issue` on GitHub, and we will review it as soon as possible. | ||
|
||
We use GitHub issues for tracking suggestions and bugs. | ||
|
||
To install for development: | ||
|
||
#### clone the repo | ||
#### Clone the repo | ||
|
||
```bash | ||
git clone https://github.com/hora-search/hora | ||
``` | ||
|
||
#### build | ||
#### Build | ||
|
||
```bash | ||
cargo build | ||
``` | ||
|
||
#### test | ||
#### Test | ||
|
||
```bash | ||
cargo test --lib | ||
``` | ||
|
||
#### try the changes | ||
#### Try the changes | ||
|
||
```bash | ||
cd exmaples | ||
cd examples | ||
cargo run | ||
``` |