github.com/hyperledger/aries-framework-go@v0.3.2/.github/CONTRIBUTING.md (about)

     1  # How to contribute
     2  
     3  *We are still working on improving these guidelines.*
     4  
     5  Thank you for taking the time to contribute to `hyperledger/aries-framework-go`!
     6  
     7  There are several ways you can contribute:
     8  
     9  * Submit a [proposal](#proposals)
    10  * Submit a [bug report](#bug-report)
    11  * Submit a [pull request](#pull-request)
    12  
    13  ## Proposals
    14  
    15  You can submit new ideas or proposals for enhancements just like any other
    16  GitHub issue.  Tag one of the
    17  [maintainers](https://github.com/orgs/hyperledger/teams/aries-framework-go-committers)
    18  in your proposal's description to get their attention.  Your proposal will be
    19  pulled into one of the project's
    20  [boards](https://github.com/hyperledger/aries-framework-go/projects) once the
    21  proposal is deemed to be worth pursuing.  From there, further discovery may be
    22  required before actual implementation work gets started.
    23  
    24  ## Bug Report
    25  
    26  Did you find a bug? Be sure to set a clear and concise title. Do your best to
    27  include a code sample that illustrates the test case. Use the
    28  [template](ISSUE_TEMPLATE.md). Also make sure:
    29  
    30  * **Required:** make sure your system satisfies all the pre-requisites listed
    31  in the `README`
    32  * **Required:** ensure the bug is not a duplicate already reported under
    33  [Issues](https://github.com/hyperledger/aries-framework-go/issues)
    34  
    35  ## Pull Request
    36  
    37  Use the [template](PULL_REQUEST_TEMPLATE.md) and also make sure:
    38  
    39  * **Required:** The build must pass. In particular, the following build targets
    40  must pass successfully:
    41    * `make checks`
    42    * `make unit-test`
    43    * `make bdd-test`
    44  * **Required:** Adherence to the  [Developer Certificate of Origin
    45  (DCO)](https://developercertificate.org/) version 1.1 (`git --signoff`).
    46  * **Required:** *squash your commits*. Yes, we know - it's nice to be able to
    47  rollback every single change you make while troubleshooting or when requested to
    48  exclude a subset or your change. The problem is the project's history tends to
    49  become polluted with useless commit messages such as "removed trailing spaces".
    50  It also makes it harder to revert specific changes when they are spread out like
    51  this. We care about preserving our project's commit history in a usable state,
    52  and as such, we politely request that you deliver your changes in a single
    53  commit.
    54  * Number of lines changed should not exceed 500. We're reasonable people - if
    55  your PR is just a *little* over the top then we might still merge it. Such cases
    56  are exceptional and are handled on a case-by-case basis.