Skip to content

Latest commit

 

History

History
130 lines (78 loc) · 4.86 KB

CONTRIBUTING.md

File metadata and controls

130 lines (78 loc) · 4.86 KB
Raw

Contributing to Identus

We would love for you to contribute to Identus and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

Developer Certificate of Origin (DCO)

Cloud Agent enforces the Developer Certificate of Origin (DCO). It requires all commit messages to contain the Signed-off-by line with an email address that matches the commit author and the name on your GitHub account.

Please read and follow set up DCO.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue.

Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.

    Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.

  • Small Features can be crafted and directly submitted as a Pull Request.

Submission Guidelines

Submitting an Issue

Before you submit an issue, please search the issue tracker. An issue for your problem might already exist and the discussion might inform you of workarounds readily available.

You can file new issues by selecting a Bug Report template on our Issues submition page.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.

  2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.

  3. Make sure all your commits have DCO sign-off line with an email address that matches the commit author and the name on your GitHub account.

  4. Fork the https://github.com/hyperledger/identus-cloud-agent repo.

  5. In your forked repository, make your changes in a new git branch:

    git checkout -b my-fix-branch main

  6. Create your patch, including appropriate test cases.

  7. Follow our Coding Rules.

  8. Ensure that all tests and CI checks pass.

  9. Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.

    git commit --all

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  10. Push your branch to GitHub:

    git push origin my-fix-branch

  11. In GitHub, send a pull request to identus-cloud-agent:main.

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-fix-branch

  • Check out the main branch:

    git checkout main -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your local main with the latest upstream version:

    git pull --ff upstream main

Commit Message Format

Please, follow our Commit Message guidelines for all commits you made, and make sure your PR title is following this format.

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more specs (unit-tests).
  • All must be documented.
  • Follow Scala Style Guide