docs(contributing): add code integration journey graph #2685
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue number: #2203
Summary
Add new graph to demonstrate steps we take from development setup until a contribution is merged.
Changes
User experience
timeline title Code integration journey (CI) Project setup <br> (make dev) : Code checkout : Virtual environment : Dependencies : Git pre-commit hooks : Local branch : Local changes : Local tests Pre-commit checks <br> (git commit) : Merge conflict check : Trailing whitespaces : TOML checks : Code linting (standards) : Markdown linting : CloudFormation linting : GitHub Actions linting : Terraform linting : Secrets linting Pre-Pull Request <br> (make pr) : Code linting : Docs linting : Static typing analysis : Tests (unit|functional|perf) : Security baseline : Complexity baseline : +pre-commit checks Pull Request <br> (CI checks) : Semantic PR title check : Related issue check : Acknowledgment check : Code coverage diff : Contribution size check : Contribution category check : Dependency vulnerability check : GitHub Actions security check : +pre-pull request checks After merge <br> (CI checks) : End-to-end tests : Longer SAST check : Security posture check (scorecard) : GitHub Actions security check : Rebuild Changelog : Deploy staging docs : Update draft releaseChecklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.