-
Notifications
You must be signed in to change notification settings - Fork 643
Update content #1111
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.
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
Merged
Merged
Update content #1111
Changes from 5 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
25e03dc
update content for agile development
785594a
add section
5c9e6d8
remove
756672a
remove
6fca223
fix
070650a
Update docs/CI-CD/README.md
shiranr dce33fd
Update docs/agile-development/async-collaboration-checklist.md
shiranr 4e1c98c
Update docs/CI-CD/README.md
shiranr 19d8d19
Update docs/agile-development/README.md
shiranr eb55625
Update docs/agile-development/async-collaboration-checklist.md
shiranr 3ad275b
Update docs/agile-development/async-collaboration-checklist.md
shiranr 41bc0c5
Update docs/agile-development/branching-and-cicd.md
shiranr bfaee7c
Update docs/agile-development/branching-and-cicd.md
shiranr e8afd48
Update docs/agile-development/branching-and-cicd.md
shiranr d568052
Update docs/agile-development/async-collaboration-checklist.md
shiranr e5b4e85
Update docs/agile-development/async-collaboration-checklist.md
shiranr 55baf29
Update docs/agile-development/branching-and-cicd.md
shiranr ee5139c
Update docs/agile-development/branching-and-cicd.md
shiranr fc47a71
Update docs/agile-development/branching-and-cicd.md
shiranr 8adcf0a
Merge branch 'main' into shiranr/update-content
shiranr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Asynchronous collaboration & accessibility checklist | ||
|
|
||
| Purpose: Practical guidance for distributed teams to collaborate effectively and inclusively across time zones. | ||
|
|
||
| ## Async standup template | ||
| - Summary (yesterday): short bullet(s) | ||
shiranr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Plan (today): short bullet(s) | ||
| - Blockers / help needed: short bullet(s) | ||
|
|
||
| Post the above in a shared channel or issue and use threaded replies for follow-ups. | ||
|
|
||
| ## Async demo guidance | ||
| - Record a short demo (5-8 minutes) focusing on the outcome and acceptance criteria. | ||
shiranr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Include a short transcript or key bullet points in the PR or release note. | ||
| - Add captions or a brief written summary for accessibility. | ||
|
|
||
| ## Accessibility checklist for artifacts | ||
shiranr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Provide alt text for images and diagrams. | ||
| - Ensure headings and lists are semantically correct in markdown. | ||
| - Provide captions/transcripts for videos and demos. | ||
| - Ensure code samples are in accessible font sizes when shared in docs. | ||
|
|
||
| ## Meeting scheduling and fairness | ||
| - Rotate meeting times or facilitators to share burden across time zones. | ||
shiranr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Use asynchronous agendas: post an agenda in advance and capture decisions in writing. | ||
|
|
||
| ## PR and review expectations | ||
| - Include a short PR description and steps to validate. | ||
shiranr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Mark urgent reviews clearly; otherwise assume a 24-48 hour review window for non-urgent PRs. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Branching & CI/CD Guidance | ||
|
|
||
| Purpose: Provide a concise, practical policy and examples teams can adopt for integration, branching and CI gating. This page is intentionally short — teams should adapt the policy to their project and toolchain. | ||
|
|
||
| ## Recommended approach | ||
| - Prefer trunk-based development where possible for new projects. Use short-lived feature branches when necessary and merge frequently into the default integration branch (commonly `main` or `trunk`). | ||
shiranr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Use branch protection rules on the integration branch to enforce quality gates (required passing CI, required code reviews, status checks). | ||
| - Keep releases simple: use tags/releases from the integration branch and keep release process documented separately. | ||
|
|
||
| ## Example branch protection rules | ||
| - Require at least one approving reviewer for pull requests. | ||
shiranr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Require successful CI pipeline status checks before merge. | ||
| - Require up-to-date branch before merge if your policy prefers. | ||
|
|
||
| ## Sample minimal GitHub Actions CI gate (example) | ||
| ```yaml | ||
shiranr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| name: ci | ||
| on: [pull_request] | ||
| jobs: | ||
| build-and-test: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Set up Node.js | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: '18' | ||
| - name: Install | ||
| run: npm ci | ||
| - name: Run tests | ||
| run: npm test | ||
| ``` | ||
| ## Merge policy checklist (suggested) | ||
| - [ ] Code compiles and automated tests pass in CI | ||
shiranr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [ ] At least one approving reviewer has reviewed the change | ||
| - [ ] The change has an associated work item or issue | ||
| - [ ] Documentation updated where applicable | ||
| ## Tips | ||
| - Keep feature branches short-lived; frequent merges reduce integration risk. | ||
shiranr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Automate as much of the gate (linting, unit tests, basic security scans) as possible to keep manual review focused on design and architecture. | ||
| - Adapt branch protection to match team size and delivery cadence. | ||
| ## CI/CD guidance | ||
| This page complements the central [CI/CD guidance](../CI-CD/README.md). Key expectations teams should follow: | ||
shiranr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - The integration (main) branch should be continuously shippable and stable — at any point we should be able to deploy a build from `main` to production if needed. | ||
| - Run a quality pipeline (linting, unit tests, basic integration tests) on each PR and on merges to the integration branch. | ||
| - Provision cloud resources and environment configuration via infrastructure-as-code (for example Terraform, Bicep, Pulumi) and exercise them in non-production environments. | ||
| - Deploy release candidates automatically to a non-production environment to validate integration and operational concerns. | ||
| - Automate release and rollback procedures so releases are repeatable and auditable. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.