Skip to content

Latest commit

 

History

History
38 lines (21 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

38 lines (21 loc) · 2.22 KB

Contributing to the EIC REST SDK

Thank you for your interest in contributing to the Java SDK! We appreciate all contributions, big or small.

Before you submit a pull request, please read through these guidelines to make sure your contribution meets our standards.

Code of Conduct

All contributors to the Java SDK must agree to abide by our Code of Conduct. This code of conduct outlines our expectations for behavior in the community, and it is important that everyone follows it in order to create a welcoming and productive environment.

Getting Started

To get started contributing to the Java SDK, you will need to create a fork of the repository on GitHub. Once you have created a fork, you can clone it to your local machine and start making changes.

When you are ready to submit your changes, you will need to create a pull request. Pull requests are the way that we review and merge changes into the main repository.

Pull Request Guidelines

When submitting a pull request, please follow these guidelines:

  • Make sure your changes are well-tested. We require all changes to be covered by unit tests.
  • Make sure your changes are well-documented. We require all changes to be documented in the code and in the README.md file.
  • Make sure your changes are formatted according to our coding style guidelines. We use the Google Java Style Guide.
  • Make sure your changes are consistent with the rest of the codebase. We want to keep the codebase consistent and easy to read.

Code Review

Once you have submitted a pull request, one of our maintainers will review your changes. The maintainer will check to make sure that your changes meet our standards and that they are ready to be merged into the main repository.

If the maintainer has any questions or concerns, they will leave a comment on your pull request. Please address the maintainer's comments before merging your pull request.

Merging Your Pull Request

Once the maintainer has approved your pull request, they will merge it into the main repository. Your changes will then be available to everyone who uses the EIC REST SDK.

Thank You!

Thank you again for your interest in contributing to the EIC REST SDK! We appreciate your help in making the SDK better for everyone.