Skip to content

Latest commit

 

History

History
48 lines (25 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

48 lines (25 loc) · 2.97 KB

Guide to Contributing to Quarkus GraphQL Quickstart

This is a project based on the Quarkus framework, and the contribution guide is written to help developers contribute to the "Quarkus GraphSQL" project. We recommend reading the Quarkus contribution guide available here and in particular the chapters:

  1. Before you contribute - https://github.com/quarkusio/quarkus/blob/main/CONTRIBUTING.md
  2. Setup - https://github.com/quarkusio/quarkus/blob/main/CONTRIBUTING.md#setup

Below, you will find a step-by-step guide on how to contribute to the "Event Bus Logging JAX-RS" project.

1. Choose an Issue or Feature to Implement

Examine the list of open issues on the project repository. Look for a problem that interests you or a feature you think would be useful to add.

You might want to implement a new feature, fix an existing bug, or improve the documentation.

2. Fork the Repository

Fork the "Event Bus Logging JAX-RS" repository to your GitHub account. This allows you to work on your fork without affecting the original repository.

3. Set Up the Development Environment

Make sure you have all the necessary dependencies for the project installed in your development environment. Refer to the project's README file for detailed instructions on how to set up the environment.

4. Work on the Selected Issue

Once you have chosen the issue or feature to address, create a new branch in your fork of the repository and start working on it. Make sure to follow the project's coding guidelines and write clean, well-documented code.

5. Test Your Changes Locally

Before submitting a pull request, make sure to test your changes locally. Run all existing tests to ensure that your code works correctly and has not introduced new bugs.

6. Submit a Pull Request

Once you are satisfied with your changes and the tests have been run, submit a pull request to the original repository. Be sure to clearly describe the changes made and why they should be accepted.

7. Participate in the Discussion

After submitting the pull request, you may need to participate in a discussion with other contributors and project maintainers. Answer questions and make requested changes if necessary.

8. Wait for Review and Approval

After submitting the pull request, the project maintainers will review your code. They may request further changes or suggest improvements. Be available to make any requested changes.

9. Celebrate Your Contribution!

Once your pull request has been accepted and your code has been included in the project, celebrate! You have just contributed to the "Event Bus Logging JAX-RS" project and made the software better for all users. Keep contributing and making a difference in the open-source community!

By following this guide, you can successfully contribute to the "Event Bus Logging JAX-RS" project and be part of its developer community. Good luck!