mirror of
https://github.com/fleetdm/fleet
synced 2026-05-22 00:18:27 +00:00
42a847d076
# Checklist for submitter If some of the following don't apply, delete the relevant line. <!-- Note that API documentation changes are now addressed by the product design team. --> - [ ] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. See [Changes files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files) for more information. - [ ] Input data is properly validated, `SELECT *` is avoided, SQL injection is prevented (using placeholders for values in statements) - [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for new osquery data ingestion features. - [ ] If paths of existing endpoints are modified without backwards compatibility, checked the frontend/CLI for any necessary changes - [ ] If database migrations are included, checked table schema to confirm autoupdate - For database migrations: - [ ] Checked schema for all modified table for columns that will auto-update timestamps during migration. - [ ] Confirmed that updating the timestamps is acceptable, and will not cause unwanted side effects. - [ ] Ensured the correct collation is explicitly set for character columns (`COLLATE utf8mb4_unicode_ci`). - [ ] Added/updated automated tests - [ ] A detailed QA plan exists on the associated ticket (if it isn't there, work with the product group's QA engineer to add it) - [ ] Manual QA for all new/changed functionality - For Orbit and Fleet Desktop changes: - [ ] Make sure fleetd is compatible with the latest released version of Fleet (see [Must rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)). - [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit feature/bugfix should only apply to one platform (`runtime.GOOS`). - [ ] Manual QA must be performed in the three main OSs, macOS, Windows and Linux. - [ ] Auto-update manual QA, from released version of component to new version (see [tools/tuf/test](../tools/tuf/test/README.md)). - [ ] For unreleased bug fixes in a release candidate, confirmed that the fix is not expected to adversely impact load test results or alerted the release DRI if additional load testing is needed. |
||
|---|---|---|
| .. | ||
| assets | ||
| research/mdm | ||
| responsibilities/mdm | ||
| Adding-new-endpoints.md | ||
| API-for-contributors.md | ||
| API-Versioning.md | ||
| Audit-logs.md | ||
| Automatically-generating-UI-component-boilerplate.md | ||
| Building-Fleet.md | ||
| Committing-Changes.md | ||
| Configuration-for-contributors.md | ||
| Deploying-chrome-test-ext.md | ||
| design-qa-considerations.md | ||
| Enroll-hosts-with-plain-osquery.md | ||
| FAQ.md | ||
| File-carving.md | ||
| Fleet-UI-Testing.md | ||
| fleetctl-apply.md | ||
| fleetd-development-and-release-strategy.md | ||
| high-level-architecture.md | ||
| Infrastructure.md | ||
| MDM-Android.md | ||
| MDM-custom-configuration-web-url | ||
| MDM-Custom-SCEP-Integration.md | ||
| MDM-DigiCert-Integration.md | ||
| MDM-end-user-authentication.md | ||
| MDM.md | ||
| Migrations.md | ||
| Patterns-backend.md | ||
| README.md | ||
| Releasing-Fleet.md | ||
| Run-Locally-Built-Fleetd.md | ||
| SCIM-integration.md | ||
| Seeding-Data.md | ||
| set-up-custom-end-user-email.md | ||
| Simulate-slow-network.md | ||
| Teams.md | ||
| Testing-and-local-development.md | ||
| Troubleshooting-live-queries.md | ||
| Understanding-host-vitals.md | ||
| Upcoming-activities.md | ||
| Upgrading-go-version.md | ||
| Vulnerability-processing.md | ||
| windows-mdm-glossary-and-protocol.md | ||
Contributing
Building Fleet
Learn about building the code, development infrastructure, and database migrations.
Build and run Fleetd from local code
Building and running your modified code.
Testing
Look at Fleet's full test suite and integration tests.
Migrations
Learn about creating and updating database migrations.
Committing changes
Learn how to merge changes into the codebase.
Releasing Fleet
Learn the process for how to release Fleet.
Seeding data
Learn how to add fake data to your development instance.
API for contributors
Get to grips with Fleet API routes. This documentation is helpful for developing or contributing to Fleet.
Deploying ChromeOS test extensions
Learn how to deploy a test version of the fleetd Chrome extension for debug purposes.
Upgrading the Go version
Learn how to update the version of Go used to build Fleet.
FAQ
Find commonly asked questions and answers about contributing to Fleet as part of our community.