New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ZachG update parametric documentation and add contributing doc #3325

Merged

ZStriker19 merged 52 commits into main from zachg/docs_contributing

Dec 2, 2024

Contributor

ZStriker19 commented Oct 25, 2024 •

edited

Loading

Motivation

A guide on how to contribute to system-tests will be very helpful for first time contributors and those who haven't contributed for some time. This should greatly reduce the startup time on getting an engineer able to write the tests they need.

Changes

Contributing guide as well as updates to the current parametric docs.

Workflow

⚠️ Create your PR as draft ⚠️
Work on you PR until the CI passes (if something not related to your task is failing, you can ignore it)
Mark it as ready for review
- Test logic is modified? -> Get a review from RFC owner. We're working on refining the codeowners file quickly.
- Framework is modified, or non obvious usage of it -> get a review from R&P team

🚀 Once your PR is reviewed, you can merge it!

🛟 #apm-shared-testing 🛟

Reviewer checklist

If PR title starts with [<language>], double-check that only <language> is impacted by the change
No system-tests internal is modified. Otherwise, I have the approval from R&P team
CI is green, or failing jobs are not related to this change (and you are 100% sure about this statement)
A docker base image is modified?
- the relevant build-XXX-image label is present
A scenario is added (or removed)?
- Get a review from R&P team

ZStriker19 added 4 commits

October 25, 2024 15:40


          add locations of all tracer servers and also the ht

79714dc

tp client in parametric.md


          starting contributing doc

5333bff


          Merge branch 'main' into zachg/docs_contributing

7973fd3


          rough draft of finished parametric contributing, also nits and added …

df56c38

…server links for parametric.md

ZStriker19 commented

View reviewed changes

docs/edit/features.md Outdated Show resolved Hide resolved

ZStriker19 commented

View reviewed changes

docs/scenarios/parametric.md Outdated Show resolved Hide resolved

ZStriker19 and others added 3 commits

November 14, 2024 18:00


          Update docs/scenarios/parametric.md

ba71013


          polish

a745414


          Merge branch 'zachg/docs_contributing' of github.com:DataDog/system-t…

b213da8

…ests into zachg/docs_contributing

ZStriker19 marked this pull request as ready for review

November 14, 2024 18:16

ZStriker19 requested a review from a team as a code owner

November 14, 2024 18:16

mtoffl01 reviewed

View reviewed changes

Contributor

mtoffl01 left a comment

Sorry for the hundreds of comments, my creative writing background gets the best of me!

docs/edit/features.md Outdated Show resolved Hide resolved

docs/scenarios/parametric.md Outdated Show resolved Hide resolved

docs/scenarios/parametric.md Outdated Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Show resolved Hide resolved

cbeauchesne requested changes

View reviewed changes

docs/edit/features.md Outdated Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved

ZStriker19 and others added 9 commits

November 25, 2024 16:06


          Update docs/edit/features.md

3eba0af

Co-authored-by: Charles de Beauchesne <charles.debeauchesne@datadoghq.com>


          Update docs/scenarios/parametric.md

26d6a74

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          Update docs/scenarios/parametric_contributing.md

605deaf

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          Update docs/scenarios/parametric_contributing.md

6175f7d

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          Update docs/scenarios/parametric_contributing.md

2feab45

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          Update docs/scenarios/parametric_contributing.md

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          Update docs/scenarios/parametric_contributing.md

1d113cb

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          Update docs/scenarios/parametric_contributing.md

ec5140a

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          Update docs/scenarios/parametric_contributing.md

edf81a1

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>

ZStriker19 commented

View reviewed changes

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved

ZStriker19 and others added 3 commits

November 25, 2024 16:21


          Update docs/scenarios/parametric_contributing.md

fcd3d5a


          Update docs/scenarios/parametric_contributing.md

f59bf65


          Update docs/scenarios/parametric.md

c250c5d

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>

ZStriker19 commented

View reviewed changes

docs/scenarios/parametric.md Outdated Show resolved Hide resolved


          Update docs/scenarios/parametric.md

85b6996

ZStriker19 commented

View reviewed changes

docs/scenarios/parametric.md Outdated Show resolved Hide resolved


          Update docs/scenarios/parametric.md

a2ac809

ZStriker19 commented

View reviewed changes

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved


          Update docs/scenarios/parametric_contributing.md

eb58191

ZStriker19 commented

View reviewed changes

docs/scenarios/parametric.md Outdated Show resolved Hide resolved

ZStriker19 commented

View reviewed changes

docs/scenarios/parametric.md Show resolved Hide resolved

ZStriker19 added 2 commits

November 26, 2024 11:59


          Apply suggestions from code review

7d1a30a


          Merge branch 'main' into zachg/docs_contributing

5242acc

mtoffl01 requested changes

View reviewed changes

docs/edit/add-new-test.md Outdated Show resolved Hide resolved

docs/edit/features.md Show resolved Hide resolved

docs/edit/features.md Show resolved Hide resolved

docs/scenarios/parametric.md Outdated Show resolved Hide resolved

docs/scenarios/parametric.md Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Show resolved Hide resolved

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved

ZStriker19 and others added 4 commits

November 26, 2024 13:38


          Update docs/edit/add-new-test.md

352718d

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          remove repeating info in features.md

5fac381


          Merge branch 'zachg/docs_contributing' of github.com:DataDog/system-t…

afd6eff

…ests into zachg/docs_contributing


          Update docs/scenarios/parametric_contributing.md

5bb0bc3

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>

ZStriker19 commented

View reviewed changes

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved


          Apply suggestions from code review

e1525b2

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>

ZStriker19 commented

View reviewed changes

docs/scenarios/parametric.md Show resolved Hide resolved

ZStriker19 and others added 2 commits

November 26, 2024 15:06


          Apply suggestions from code review

2a0f6cd

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          Merge branch 'main' into zachg/docs_contributing

e8e06b7

mabdinur approved these changes

View reviewed changes

Contributor

mabdinur left a comment

Left one last nit. Overall looks great to me!

docs/scenarios/parametric_contributing.md Outdated Show resolved Hide resolved

ZStriker19 and others added 2 commits

November 27, 2024 11:22


          add link to contributing doc in main readme.md

a5f9c6a


          Update docs/scenarios/parametric_contributing.md

f9cc7b5

Co-authored-by: Munir Abdinur <munir_abdinur@hotmail.com>

mtoffl01 approved these changes

View reviewed changes

Contributor

mtoffl01 left a comment

Some small nits but otherwise, good to go.
But also, since you said your docs don't contain contributing information for weblog, can you just make the change in your PR to remove the empty [TODO]: LINK TO CONTRIBUTING DOC link in this doc? https://github.com/DataDog/system-tests/blob/main/docs/edit/enable-test.md

docs/edit/features.md Outdated Show resolved Hide resolved

docs/edit/features.md Outdated Show resolved Hide resolved

docs/scenarios/parametric.md Outdated Show resolved Hide resolved

cbeauchesne reviewed

View reviewed changes

docs/edit/README.md Outdated Show resolved Hide resolved

ZStriker19 and others added 7 commits

December 2, 2024 12:29


          Update docs/edit/features.md

7fd96ed

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          Update docs/edit/features.md

ed9a72c

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          Update docs/scenarios/parametric.md

9315e67

Co-authored-by: Mikayla Toffler <46911781+mtoffl01@users.noreply.github.com>


          Update docs/edit/README.md

cc40375

Co-authored-by: Charles de Beauchesne <charles.debeauchesne@datadoghq.com>


          remove todo for link

6c0335b


          Merge branch 'zachg/docs_contributing' of github.com:DataDog/system-t…

750fe09

…ests into zachg/docs_contributing


          Merge branch 'main' into zachg/docs_contributing

605f18f

ZStriker19 merged commit 3ad6ff1 into main

280 of 281 checks passed

ZStriker19 deleted the zachg/docs_contributing branch

December 2, 2024 18:55

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet