empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 00:45:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
de5695659a
fleet/docs/Contributing
History
Marko Lisica de5695659a
Batch-apply scripts: parameters documented incorrectly (#14653) 
# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] 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.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] 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)).
2023-10-26 10:59:10 +02:00
..
Adding-new-endpoints.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
API-for-contributors.md Batch-apply scripts: parameters documented incorrectly (#14653) 2023-10-26 10:59:10 +02:00
API-Versioning.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
Automatically-generating-UI-component-boilerplate.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
Building-Fleet.md Docs: add syntax highlighting keywords to code blocks (#13963) 2023-09-22 16:57:40 -05:00
Committing-Changes.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
Configuration-for-contributors.md document flags required for fleetd error reporting (#14656) 2023-10-19 23:49:18 -05:00
Deploying-chrome-test-ext.md Docs: add syntax highlighting keywords to code blocks (#13963) 2023-09-22 16:57:40 -05:00
FAQ.md Merging Bitlocker feature branch (#14350) 2023-10-06 19:04:33 -03:00
Fleet-UI-Testing.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
fleetd-development-and-release-strategy.md Docs: Replace Orbit with Fleetd (#12443) 2023-07-21 19:33:31 -05:00
Migrations.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
README.md Docs: Replace Orbit with Fleetd (#12443) 2023-07-21 19:33:31 -05:00
Releasing-Fleet.md Document milestone release ritual (#13932) 2023-09-25 14:35:36 -05:00
Run-Locally-Built-Fleetd.md Docs: add syntax highlighting keywords to code blocks (#13963) 2023-09-22 16:57:40 -05:00
Seeding-Data.md Docs: add syntax highlighting keywords to code blocks (#13963) 2023-09-22 16:57:40 -05:00
Simulate-slow-network.md Website: Add meta descriptions to Fleet documentation. (#12586) 2023-07-13 11:57:17 -05:00
Testing-and-local-development.md Windows MDM docs: turn on Windows MDM (#13943) 2023-10-04 15:39:09 -04:00

README.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.

FAQ

Find commonly asked questions and answers about contributing to Fleet as part of our community.