Skip to content

Latest commit

 

History

History
79 lines (59 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

79 lines (59 loc) · 2.77 KB
Raw

Contributing

👋 Hello! Thanks for your interest in contributing to the dependabot CLI!

We accept pull requests for bug fixes and features that have been discussed ahead of time in an issue. We'd also love to hear about ideas for new features as issues.

Please do:

  • Check existing issues to verify that the bug or feature request has not already been submitted.
  • Open an issue if things aren't working as expected
  • Open an issue to propose a significant change
  • Open a pull request to fix a bug
  • Open a pull request to fix documentation about a command
  • Open a pull request for any issue labelled help wanted or good first issue

Building the project

Prerequisites:

  • Go 1.19+
  • Docker

Run with: go run ./...

Run tests with: go test ./...

Submitting a pull request

  1. Create a new branch: git checkout -b my-branch-name
  2. Make your change, add tests, and ensure tests pass
  3. Submit a pull request: gh pr create --web

Contributions to this project are released to the public under the project's open source license.

Please note that this project adheres to a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Releasing

Maintainers can create a new release by following these instructions:

  1. Go to the releases page
  2. Determine the appropriate version number for the release following SemVer guidelines.
  3. Click the Draft a new release button
  4. Click the Choose a tag button
  5. Type in the version number for the release preceded by a v
  6. Click the Publish release button

Publishing a release triggers the release.yml workflow, which builds artifacts and uploads them to the release.

Resources