-
Notifications
You must be signed in to change notification settings - Fork 16
Description
🆕🐥 First Timers Only
This issue is reserved for people who have never contributed to this project or any open source software (OSS) in general.
We know that creating a pull request (PR) is a major barrier for new contributors.
This issue is reserved for people who have never contributed to this project or any open source software (OSS) in general.
We know that creating a pull request (PR) is a major barrier for new contributors.
The goal of this issue and all other issues labeled by 'good first issue' is to help you make your first contribution.
👾 Description of the issue
The project provides some REST endpoints that are defined in ApiEndpoint.java. For that endpoints a Swagger UI should be provided. The Swagger UI should be part of the (Spring Boot) application. A documentation for that topic can be found here.
📋 Step by step guide to do a contribution
If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow.
A more detailed general documentation of the GitHub PR workflow can be found here.
- Claim this issue: Comment below that you are interested in working on the issue
- Wait for assignment: A community member with the given rights will add you as an assignee of the issue
- Fork the repository: You can do that in GitHub (by simply clicking the 'fork' button)
- Check out the forked repository on your local machine
- Create a feature branch for the issue
- Solve the issue in your branch
- Commit your changes: to your branch
- Start a Pull Request (PR): in our repository
- Check GitHub Actions: Several GitHub Actions will be triggered automatically for each PR. If a GitHub Action fails and you do not understand the cause of that error, do not hesitate to add a comment to the PR and ask the community for support.
- Wait for reviews: Members of the community will review your PR. If a reviewer finds any missing pieces or a problem, he or she will discuss it with you and describe the next steps for solving it.
- You did it 🎉: We will merge the fix in the develop branch. Thanks for being part of our community as an open-source contributor ❤️
🎉 Contribute to Hacktoberfest
Solve this issue as part of the Hacktoberfest event and get a chance to receive cool goodies like a T-Shirt. 🎽