Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sboeckelmann authored Jun 2, 2023
1 parent cfb515f commit 1702e83
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## Contributing at quarkus-opensearch
We are beyond excited to see that you want to contribute! We would love to accept your contributions. Navigate through the following to understand more about contributing.

### Prerequisites
- Java 11
- Apache Maven

## Follow the Steps
- [Fork the repository](https://github.com/quarkiverse/quarkus-opensearch/fork)

- Clone the project locally

```
git clone https://github.com/your-username/quarkus-opensearch.git
```
**Note:** In the place of `your-username` you have to add your github username.

- Create a new branch

```
git checkout -b <your branch_name>
```

After creating new branch start making your changes and once the changes done then push your changes and then create a ` pull_request`
- Push your changes

```
git push origin <your branch_name>
```

Now you have to wait for the review. The project maintainer will review your PR and once your PR got approve then they will merged it. If you want to support, please give a ⭐

### Things to remember before making changes

Before making any contribution make sure your local `main` keep up-to-date with upstream `main`. To do that type the following commands.

- First add upstream
```
git remote add upstream https://github.com/quarkiverse/quarkus-opensearch.git
```
- Pull all changes from upstream
```
git pull upstream main
```
- Keep your fork up-to-date
```
git push origin main
```

0 comments on commit 1702e83

Please sign in to comment.