Skip to content
This repository has been archived by the owner on Sep 13, 2022. It is now read-only.

Latest commit

 

History

History
68 lines (50 loc) · 4.07 KB

CONTRIBUTING.md

File metadata and controls

68 lines (50 loc) · 4.07 KB
Raw

Contributing to 'Eclipse Keyple' C++ implementation

Thanks for your interest in this project.

Project description

'Eclipse Keyple' C++ implementation is a project containing all the content of the C++ implementation of the Eclipse Keyple API.

Eclipse Contributor Agreement

Before your contribution can be accepted by the project team contributors must electronically sign the Eclipse Contributor Agreement (ECA).

Commits that are provided by non-committers must have a Signed-off-by field in the footer indicating that the author is aware of the terms by which the contribution has been provided to the project. The non-committer must additionally have an Eclipse Foundation account and must have a signed Eclipse Contributor Agreement (ECA) on file.

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

Eclipse Contributor Agreement

Before your contribution can be accepted by the project team contributors must electronically sign the Eclipse Contributor Agreement (ECA).

Commits that are provided by non-committers must have a Signed-off-by field in the footer indicating that the author is aware of the terms by which the contribution has been provided to the project. The non-committer must additionally have an Eclipse Foundation account and must have a signed Eclipse Contributor Agreement (ECA) on file.

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

Contribute via Fork

You need a GitHub and an Eclipse account for which you signed the Eclipse Contributor Agreement.

  1. Fork the repository on GitHub
  2. Check if there is a Jira issue for what you want to work on or create one.
  3. Announce in the comments section that you want to work on the issue. Also describe the solution you want to implement. To improve the chances for your contribution to be accepted, you'll want to wait for the feedback of the committers.
  4. Create a new branch from develop for your changes. Name it after the Jira number, e.g. KCPP-XXX_[descriptionofchanges].
  5. Implement your changes.
  6. Rebase on develop.
  7. Commit using Sign off with the same email address you are using for your Eclipse account. Use descriptive and meaningful commit messages. In particular, start the first line of the commit message with the number of the issue that the commit addresses, e.g. KEYP-XXX [descriptionofchanges].
  8. Push your changes to your forked repository.
  9. Create a pull request (PR) to develop.
  10. After submitting, do not use your branch for any other development, otherwise further changes that you make will be visible in the PR.

Contributing for Committers

You're a committer if you have write-access to the Keyple git-repositories.

  1. Make sure there is a Jira issue for what you want to work on or create one.
  2. Assign the issue to yourself.
  3. Create a local git branch from develop. Name it after the Jira number, e.g. KCPP-XXX_[descriptionofchanges].
  4. Implement your changes.
  5. Rebase on develop.
  6. Commit using Sign off with the same email address you are using for your Eclipse account. Use descriptive and meaningful commit messages. In particular, start the first line of the commit message with the number of the issue that the commit addresses, e.g. KEYP-XXX Update Keyple Core Unit tests.
  7. Push the branch into the repository.
  8. Create a pull request and ask somebody who is familiar with the code you modified to review it.
  9. If the reviewer approves and all checks are OK, merge using squash commit.