search

CommunityToolkit / WindowsCommunityToolkit-wiki

Wiki fork for main WindowsCommunityToolkit repo with project Documentation and Guidance
Other
8 stars 8 forks source link

Clarification of 'Feature Branch' in PR Guidance #40

Closed michael-hawker closed 2 years ago

michael-hawker commented 3 years ago

@RosarioPulella I think it'd be interesting to specify an example of what a feature branch is for this repo (not the main branch, whichever the name and format, if I understand correctly). "Feature" has very different meanings depending on repositories.

Originally posted by @jeromelaban in https://github.com/CommunityToolkit/WindowsCommunityToolkit/issues/4148#issuecomment-909424841

ghost commented 3 years ago

Hello michael-hawker, thank you for opening an issue with us!

I have automatically added a "needs triage" label to help get things started. Our team will analyze and investigate the issue, and escalate it to the relevant team if possible. Other community members may also look into the issue and provide feedback 🙌

michael-hawker commented 3 years ago

For background the reason we have this policy is that we once noticed a whole feature of the Toolkit was deleted between versions once. We noticed later when we browsed the history that someone had deleted these files (for some reason) in their own local main branch.

That wasn't show in the PR difference when comparing their main branch to ours with the new features (for some reason) and therefore the PR was merged with the offending deletes as well which got merged into the history.

Therefore, to ensure a stable environment, we ask that folks branch off of our main into a named non-main branch of their forked repository to start any new feature development. This should better ensure that deletions in a PR review are caught and not merged into our main branch unexpectedly.

jeromelaban commented 3 years ago

Rules are there for a good reason, for sure (generally learnt the hard way!).