Skip to content

Commit

Permalink
Update Rule “dont-push-your-pull-requests/rule” (SSWConsulting#7236)
Browse files Browse the repository at this point in the history
* Update Rule “dont-push-your-pull-requests/rule”

* Update rule.md

---------

Co-authored-by: Tiago Araújo [SSW] <[email protected]>
  • Loading branch information
BrookJeynes and tiagov8 authored Nov 14, 2023
1 parent 42537c2 commit d5aefea
Showing 1 changed file with 29 additions and 39 deletions.
68 changes: 29 additions & 39 deletions rules/dont-push-your-pull-requests/rule.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
---
type: rule
archivedreason:
title: Do You Know to not 'Push' your Pull Requests? (a.k.a. discuss then build)
guid: 4a8b579b-c602-429c-84f2-0f306d7ab9c3
title: Do you know to not 'push' your Pull Requests? (aka Discuss, then build)
uri: dont-push-your-pull-requests
created: 2016-03-29T18:35:55.0000000Z
authors:
- title: Adam Stephensen
url: https://ssw.com.au/people/adam-stephensen
- title: Adam Stephensen
url: https://ssw.com.au/people/adam-stephensen
related: []
redirects:
- do-you-know-to-not-push-your-pull-requests-a-k-a-discuss-then-build
- do-you-know-to-not-push-your-pull-requests-(a-k-a-discuss-then-build)

- do-you-know-to-not-push-your-pull-requests-a-k-a-discuss-then-build
- do-you-know-to-not-push-your-pull-requests-(a-k-a-discuss-then-build)
created: 2016-03-29T18:35:55.000Z
archivedreason: null
guid: 4a8b579b-c602-429c-84f2-0f306d7ab9c3
---

For the original article check out [Don't "Push" Your Pull Requests](https&#58;//www.igvita.com/2011/12/19/dont-push-your-pull-requests/)by Ilya Grigorik.
For the original article check out [Don't "Push" your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/)by Ilya Grigorik.

Open source software projects love it when the community get involved and pitch in.

Expand All @@ -25,8 +24,8 @@ A short pull request to fix a small problem is easy to review and accept.

<!--endintro-->

It's great when someone adds a much-needed feature
...as long as the feature fits in with the project the core contributors have for the project
It's great when someone adds a much-needed feature...
...as long as the feature fits in with the project the core contributors have for the project...
...and it meets the existing coding patterns and engineering standards.

This is where frustration often starts to set in on open source projects.
Expand All @@ -35,53 +34,44 @@ A contributor has a great idea for a feature, or identifies an area where they c

Their contribution might solve their problem, but after it has been accepted it will most likely be left for the core contributors to maintain.


::: greybox

**# Poor Communication Contribution**

* developer has good idea for project
* bashes away and writes 600 lines of code
* submits pull request
* core contributor looks at large pull request
she doesn't fully understand purpose of request / the problem it solves
she doesn't like that the PR author hasn't followed the existing coding standards
she makes a push back comment

**Poor Communication Contribution**

* Developer has good idea for project
* Bashes away and writes 600 lines of code
* Submits Pull Request
* Core contributor looks at large PR
* They don't fully understand purpose of request / the problem it solves
* They don't like that the PR author hasn't followed the existing coding standards
* They make a push back comment
:::


::: bad
Figure: Bad Example - Poor early communication can lead to mis-directed work and pull requests not being accepted
Figure: Bad example - Poor early communication can lead to mis-directed work and pull requests not being accepted
:::


::: greybox

**# Good Communication Contribution**

* developer (PR Author) has good idea for project
* reviews the list of outstanding issues for the project and confirms that someone hasn't already had the same idea and started a discussion on it
* author creates an issue on GitHub and outlines the problem they are trying to solve, and outlines their suggested solution
* the core contributors and other interested parties can help refine both the idea for the feature and the suggested implementation
* the author can then start working on the feature knowing that their idea for the project complies with the maintainers vision for the project and know it is likely to be merged into the core codebase

**Good Communication Contribution**

* Developer (PR Author) has good idea for project
* Reviews the list of outstanding issues for the project and confirms that someone hasn't already had the same idea and started a discussion on it
* Author creates an issue on GitHub and outlines the problem they are trying to solve, and outlines their suggested solution
* The core contributors and other interested parties can help refine both the idea for the feature and the suggested implementation
* The author can then start working on the feature knowing that their idea for the project complies with the maintainers vision for the project and know it is likely to be merged into the core codebase
:::


::: good
Figure: Good  Example - Good communication leads to collaboration and better outcomes for the author and the project
Figure: Good example - Good communication leads to collaboration and better outcomes for the author and the project
:::


::: greybox
::: info

**# Projects with Internal Teams**

* Internal SSW team members should only work on features during work hours that have been assigned to a release by the core contributors for a project
* Internal team members should only work on features during work hours that have been assigned to a release by the core contributors for a project
* Features will be assigned to a release during the Community Standup


:::

0 comments on commit d5aefea

Please sign in to comment.