-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
06c7cfc
commit 5db8c0a
Showing
1 changed file
with
48 additions
and
0 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 |
---|---|---|
@@ -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 | ||
``` |