Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add: CONTRIBUTING.md #325

Merged
merged 1 commit into from
Apr 17, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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-quinoa
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-quinoa/fork)

- Clone the project locally

```
git clone https://github.com/shivam-sharma7/quarkus-quinoa.git
```
**Note:** In the place of `shivam-sharma7` 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-quinoa.git
```
- Pull all changes from upstream
```
git pull upstream main
```
- Keep your fork up-to-date
```
git push origin main
```