bluerobotics / bluerobotics/software-guidelines

Add explanation of why master branch is protected and push force should not happen

Open
#6 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
12
Forks
7
PR merge metrics
No merged PRs in 30d

Description

We did discussed that before and we ended up the current approach, minor changes can appear to be safe, but they may not be or could be done in a better way, so to avoid such problem and be sure that we are not doing something crazy, we agreed to have at least a single approved to any PR, more approves may be necessary if the change is complex or if you desire to have more eyes to be sure that the current approach is correct or may broken something that you are not aware.
We have master branch protected for the majority of our repositories.
PR's are really simple to do, and should not hold your workflow, you can open as much PRs that you feel like, or a single PR with a bunch of fixes. If you are waiting to merge something to add to the documentation before talking with an user, you can ping someone directly and we could approve asap.

> I generally avoid committing directly to master, ever. Even a [pr as simple as this one](https://github.com/bluerobotics/companion/pull/409) could break I forgot we are at Python 3.4 and tried to use f-strings in there.
while there is some extra work to it, these ones are pretty easy to do and quick to review.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.