CONTRIBUTING.md

Contributing to bindplane-agent

Pull Requests

How to Submit Pull Requests

Everyone is welcome to contribute code to bindplane-agent via GitHub pull requests (PRs).

To create a new PR, fork the project in GitHub and clone the upstream repo:

$ git clone https://github.com/observIQ/bindplane-agent

This would put the project in the bindplane-agent directory in current working directory.

Enter the newly created directory and add your fork as a new remote:

$ git remote add <YOUR_FORK> [email protected]:<YOUR_GITHUB_USERNAME>/bindplane-agent

Check out a new branch, make modifications, run linters and tests, and push the branch to your fork:

$ git checkout -b <YOUR_BRANCH_NAME>
# edit files
$ make test
$ git add
$ git commit
$ git push --set-upstream <YOUR_FORK> <YOUR_BRANCH_NAME>

Open a pull request from your fork and feature branch to the main branch of the bindplane-agent repo.

Note: If the PR is not ready for review, mark it as draft.

Commands to run before submitting PR

Our CI runs the following checks on each PR. You can run the following local commands to ensure your code is ready for PR:

• Build (make agent)
• CI Checks (make ci-checks)

How to Receive Feedback

If you're stuck, tag a maintainer and ask a question. We're here to help each other.

How to Get PRs Merged

A PR is considered to be ready to merge when:

• It has received approval from at least two maintainers.
• CI passes.
• Major feedback is resolved.

Tag a maintainer to request a merge once the above is complete.