Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 2 KB
Raw

Contributing

If you have an idea or feature request please open an issue, even if you don't have time to contribute!

Making Changes

Note: This guide assumes you have a working Go 1.17 (or later) installation.

To get started, fork this repository on GitHub and clone a working copy for development:

$ git clone git@github.com:YOUR-USERNAME/go-hid.git

Once you are finished, be sure to test changes locally by issuing:

$ go test ./...

Finally, commit your changes and create a pull request against the default branch for review.

Making Releases

Making releases is automated by GitHub Actions. Releases should only be created from the default branch; as such, tests should be passing at all times.

To make a release, follow these steps:

  1. Create a section in CHANGELOG.md for the version, and move items from Unreleased to this section. Links should also be updated to point to the correct tags for comparison.

  2. Commit outstanding changes by issuing:

    $ git commit -a -m 'Release v<version>'

  3. Push changes to the remote repository and verify the results of the CI workflow:

    $ git push origin <default-branch>

  4. Create a release tag by issuing:

    $ git tag -a -m 'Release v<version>' v<version>

  5. Push the release tag to the remote repository and verify the results of the Release workflow:

    $ git push origin --tags

License

By contributing to this repository, you agree that your contributions will be licensed under its Simplified BSD License.