Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.83 KB

File metadata and controls

30 lines (19 loc) · 1.83 KB

Project overview

Read CONTRIBUTING.md First

BEFORE writing or editing ANY code, you MUST read CONTRIBUTING.md and README.md.

Furthermore, be sure to follow Effective Go guidelines when writing Go code.

Use the following AGENTS.md files when making specific changes:

Updating Documentation

This AGENTS.md should be short. Only update this file if a new AGENTS.md file is added, so it must be added to the list with its purpose.

The developer should update CONTRIBUTING.md with new, significant features. A feature may be considered significant when:

  1. It introduces a new method of interacting with and/or customizing the tracer (ie new scripts for generating files, options for configuration sources, etc)
  2. A new internal functionality is introduced that can replace a common, built-in Go library
  3. The make command supports a new flag that introduces new testing/linting/building functionality AND/OR
  4. A new CI workflow in GitHub or GitLab is created

The developer should also update README.md with new options to the make command and other important commands that are essential for testing or building the tracer.

If these updates are not made, tell the developer to make changes or provide suggestions if requested.