Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 2.56 KB
Raw

Contributing

IPDK uses GitHub to manage reviews of pull requests.

  • If you are a new contributor see: Steps to Contribute

  • If you have a trivial fix or improvement, go ahead and create a pull request, addressing (with @...) a suitable maintainer of this repository (see MAINTAINERS.md) in the description of the pull request.

  • Be sure to sign off on the DCO.

Issues

We use GitHub Issues to track issues for the IPDK project. If you come across a bug, please feel free to open issue. Ideally, you would include as much information below in the issue:

  • Clear title presenting the issue.
  • A solid description with steps to reproduce the issue.
  • Are you using the IPDK container, or running natively?
  • Which supported version of the base OS are you running?

Steps to Contribute

Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue.

Pull Request Checklist

  • Branch from the main branch and, if needed, rebase to the current main branch before submitting your pull request. If it doesn't merge cleanly with main you may be asked to rebase your changes.

  • Make sure you write a good commit message. Commit messages matter, it's important for other developers to understand the context behind your commit. For help, this article is a good place to start.

  • Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests). NOTE: For a list of tests, see the existing GitHub Actions defined here.

  • If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment. You can also ping maintainers on the IPDK Slack.

  • Add tests relevant to the fixed bug or new feature.

Pull Request Merging

  • Assuming you've followed the steps to prepare your PR, reviewers will review you pull request. These could be general members of the community, as well as maintainers.

  • Pull requests will be reviewed by one or more maintainers and merged when acceptable.