Development

HoneyTrap Development

Creating a Documentation Pull Request

To contribute to the HoneyTrap documentation, create a pull request against the honeytrap/honeytrap-docs repository. This page shows how to create a pull request.

Before you begin

  1. Create a GitHub account.

  2. Sign the Linux Foundation Contributor License Agreement.

Documentation will be published under the CC BY SA 4.0 license.

Creating a fork of the HoneyTrap documentation repository

  1. Go to the honeytrap/honeytrap-docs repository.

  2. In the upper-right corner, click Fork. This creates a copy of the HoneyTrap documentation repository in your GitHub account. The copy is called a fork.

Making your changes

  1. In your GitHub account, in your fork of the HoneyTrap docs, create a new branch to use for your contribution.

  2. In your new branch, make your changes and commit them. If you want to write a new topic, choose the page type that is the best fit for your content.

Submitting a pull request to the master branch (Current Release)

If you want your change to be published in the released version HoneyTrap docs, create a pull request against the master branch of the HoneyTrap documentation repository.

  1. In your GitHub account, in your new branch, create a pull request against the master branch of the honeytrap/honeytrap-docs repository. This opens a page that shows the status of your pull request.

  2. Click Show all checks. Wait for the deploy/netlify check to complete. To the right of deploy/netlify, click Details. This opens a staging site where you can verify that your changes have rendered correctly.

  3. During the next few days, check your pull request for reviewer comments. If needed, revise your pull request by committing changes to your new branch in your fork.

Pull request review process for current release

Once your pull request is created, a HoneyTrap reviewer will take responsibility for providing clear, actionable feedback. As the owner of the pull request, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the HoneyTrap reviewer. Also note that you may end up having more than one HoneyTrap reviewer provide you feedback or you may end up getting feedback from a HoneyTrap reviewer that is different than the one originally assigned to provide you feedback. Furthermore, in some cases, one of your reviewers might ask for a technical review from a HoneyTrap tech reviewer when needed. Reviewers will do their best to provide feedback in a timely fashion but response time can vary based on circumstances.

What’s next