Skip to content
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

Add docs for how web-features syncs with BCD #2560

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Elchi3
Copy link
Collaborator

@Elchi3 Elchi3 commented Jan 21, 2025

@Elchi3 Elchi3 requested a review from ddbeck January 21, 2025 14:49
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 21, 2025
docs/bcd-workflow.md Outdated Show resolved Hide resolved
docs/bcd-workflow.md Outdated Show resolved Hide resolved
docs/bcd-workflow.md Outdated Show resolved Hide resolved
docs/bcd-workflow.md Outdated Show resolved Hide resolved
docs/bcd-workflow.md Outdated Show resolved Hide resolved
docs/bcd-workflow.md Outdated Show resolved Hide resolved
docs/bcd-workflow.md Outdated Show resolved Hide resolved
@Elchi3
Copy link
Collaborator Author

Elchi3 commented Jan 22, 2025

Thanks for the review, Patrick, and the partial review, Daniel! I updated this PR to avoid the word "workflow". This might use GitHub actions/workflows but it really is an implementation detail. The goal of this document is more for maintainers to understand how BCD and web-features work together and how compat_feature lists and BCD tags are synchronized conceptually.

Copy link
Collaborator

@jamesnw jamesnw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good!

I'm wondering about a high level TLDR, something like "Either way is fine. If you're authoring a new feature, add the keys in web-features. If you're changing keys in BCD, make the change there. The goal is to limit the times where you have to make PRs in both repositories."

docs/bcd-sync.md Outdated Show resolved Hide resolved
docs/bcd-sync.md Outdated Show resolved Hide resolved
docs/bcd-sync.md Show resolved Hide resolved
docs/bcd-sync.md Outdated Show resolved Hide resolved
docs/bcd-sync.md Show resolved Hide resolved
docs/bcd-sync.md Outdated Show resolved Hide resolved
docs/bcd-sync.md Outdated Show resolved Hide resolved
docs/bcd-sync.md Outdated Show resolved Hide resolved
docs/bcd-sync.md Outdated Show resolved Hide resolved
docs/bcd-sync.md Outdated Show resolved Hide resolved
docs/bcd-sync.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants