Versions Compared

Old Version 1

changes.mady.by.user Richard Esplin

Saved on

compared with

New Version 2

changes.mady.by.user Richard Esplin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Reporting an Issue

A good bug report is easy for others to understand. If they cannot reproduce your issue, they are unlikely to be able to address it.

...

  1. It is preferable to start with a Jira issue, as other might contribute guidance on the best way to diagnose and fix the problem.
  2. Then submit a Pull Request in GitHub with your suggested changes.
    1. Don't forget to include a unit test which reproduces the problem and is fixed by the PR.
    2. Reference the associated Jira issue in the PR title.
    3. Sign your commit to provide an attestation of the DCO.
  3. Wait
    1. CI will be run on your PR.
    2. Once CI passes, a maintainer will review your PR.
    3. If the maintainer asks for changes, you will need to respond.
    4. Once the maintainer is happy, the PR will be accepted and included in the next release.

...

  1. It is preferable for you to start with a Jira issue before putting in significant effort.
    1. Get feedback on whether the community is interested in the feature.
    2. Solicit ideas on the best way to approach the implementation.
  2. Consider submitting a HIPE
    1. If the change impacts more than one project, then a Hyperledger Indy Project Enhancement needs to be discussed.
    2. Submit a Pull Request in GitHub with your architecture plan to the design folder of the repository you are changing.
      1. The architects and maintainers will give you feedback and suggestions when accepting the design.
      2. The design then becomes part of the developer documentation.
    3. Submit a Pull Request in GitHub with your changes.
      1. Sign your commit to provide an attestation of the DCO.
      2. Don't forget to update all relevant tests, changes to CI / CD, documentation, translations, etc.
    4. Wait
      1. CI will be run on your PR.
      2. Once CI passes, a maintainer will review your PR.
      3. If the maintainer asks for changes, you will need to respond.
      4. Once the maintainer is happy, the PR will be accepted and included in the next release.

...