Skip to content

Latest commit

 

History

History
108 lines (70 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

108 lines (70 loc) · 3.51 KB
Raw

Contributing to Eclipse Hara

Thanks for your interest in this project.

Project description

Eclipse Hara™ provides a reference agent software implementation featuring the Eclipse hawkBit device API.

Hara-ddiclient is a Kotlin library that facilitates and speeds up the development of DDI API clients for devices connecting to hawkBit servers.

Terms of Use

This repository is subject to the Terms of Use of the Eclipse Foundation

Developer resources

Information regarding source code management, builds, coding standards, and more.

The project maintains the following source code repositories

Eclipse Development Process

This Eclipse Foundation open project is governed by the Eclipse Foundation Development Process and operates under the terms of the Eclipse IP Policy.

Eclipse Contributor Agreement

In order to be able to contribute to Eclipse Foundation projects you must electronically sign the Eclipse Contributor Agreement (ECA).

The ECA provides the Eclipse Foundation with a permanent record that you agree that each of your contributions will comply with the commitments documented in the Developer Certificate of Origin (DCO). Having an ECA on file associated with the email address matching the "Author" field of your contribution's Git commits fulfills the DCO's requirement that you sign-off on your contributions.

For more information, please see the Eclipse Committer Handbook: https://www.eclipse.org/projects/handbook/#resources-commit

Conventions

License Header

Please make sure newly created files contain a proper license header like this:

/*
 * Copyright (c) <year> <author> and others.
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 */

Making your changes

  • Fork the repository on GitHub
  • Create a new branch for your changes
  • Make your changes
  • Make sure you include tests
  • Make sure the tests pass after your changes
  • Commit your changes into that branch
  • Use descriptive and meaningful commit messages
  • If you have a lot of commits squash them into a single commit
  • Make sure you use the -s flag when committing as explained above.
  • Push your changes to your branch in your forked repository

Submitting the changes

Submit a pull request via the normal GitHub UI (desktop or web).

After submitting

  • Do not use your branch for any other development, otherwise further changes that you make will be visible in the PR.

Reporting a security vulnerability

If you find a vulnerability, DO NOT disclose it in the public immediately! Instead, give us the possibility to fix it beforehand. So please don’t report your finding using GitHub issues and better head over to https://eclipse.org/security and learn how to disclose a vulnerability in a safe and responsible manner

Further information

Contact

Contact the project developers via the project's "dev" list.