Skip to content

Commit

Permalink
Merge pull request #128 from thinktandem/2020goalz
Browse files Browse the repository at this point in the history
2020goalz
  • Loading branch information
pirog authored Mar 23, 2020
2 parents 81161d0 + 964ca13 commit 4e60bec
Show file tree
Hide file tree
Showing 8 changed files with 43 additions and 267 deletions.
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/discussion.md

This file was deleted.

7 changes: 0 additions & 7 deletions .github/ISSUE_TEMPLATE/note.md

This file was deleted.

31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/task.md

This file was deleted.

41 changes: 0 additions & 41 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ In order to do that I need to first go through the below checklist entitled "For

If they do not review in the time alloted or have no change requests or blocking concerns _**the person who opened the pull request**_ will apply the "Ready to merge" label which will ping the Keepers of Faith to press the merge button.

## For me

### Bare minimum self-checks

> [What do you think of a person who only does the bare minimum?](https://getyarn.io/yarn-clip/dcf80710-425e-478b-bde1-c107bd11e849)
Expand All @@ -17,7 +15,6 @@ If they do not review in the time alloted or have no change requests or blocking
- [ ] I've written an acceptance test below for the reviewer
- [ ] I've ensured all automated tests pass
- [ ] I've [connected this PR to an issue](https://help.zenhub.com/support/solutions/articles/43000010350-connecting-pull-requests-to-github-issues)
- [ ] I've gone into that issue and if it is a task with a linked "next task" i've gone into that task and made its next task or prompted a discussion there about what its next task should be

### Pieces of flare

Expand All @@ -30,41 +27,3 @@ If they do not review in the time alloted or have no change requests or blocking
- [ ] I've [requested a review](https://help.github.com/en/articles/requesting-a-pull-request-review) with relevant people
- [ ] I've moved this ticket into the "Ready for review" swimlane

## For the reviewer

### Acceptance Test

THE PERSON WHO SUBMITS THE PR SHOULD PUT THEIR ACCEPTANCE TEST HERE.

The acceptance test should detail the steps the reviewer can take to

1. Replicate the "issue" on the mainline site
2. Showcase the "fix" on the PR environment spun up on platform.sh.

Here is a _very simple_ example you can follow

#### Steps to replicate

1. Provide a link to the prod or dev site
2. Navigate to the homepage, see that the background is neon green

#### Fix

1. Provide a link to the QA environment
2. Navigate to the homepage and see that the background is blue

### Reviewer checks

I've completed the following tasks and requested changes from the submitter if changes were needed before a :+1: could be given.

- [ ] I've read the [QAing Code Guide](https://docs.thinktandem.io/guides/qaing-code.md)
- [ ] I've verified the developers QA checklist eg "For me" has been completed to a level i am ok with
- [ ] I've manually reviewed the code and it checks out
- [ ] I've manually validated the acceptance test(s)
- [ ] I've summoned an additional reviewer if I need a second (or third, or fourth, ... or nth) opinion

## For the Keeper(s) of the Faith

- [ ] We've attempted to find a follow up issue if needed and if needed we've requested it be created
- [ ] We've verified this does not wildly diverge from our mission, goals, roadmap, values etc

7 changes: 3 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
language: node_js
node_js:
- '10'
node_js: '12'
dist: xenial
services:
- docker
before_install:
- sudo apt-get -y update
- sudo apt-get -y install cgroup-bin curl
- sudo bash -c "curl -Ls https://github.com/lando/hyperdrive/releases/download/v0.5.4/hyperdrive > /usr/local/bin/hyperdrive"
- sudo bash -c "curl -Ls https://github.com/lando/hyperdrive/releases/download/v0.6.1/hyperdrive > /usr/local/bin/hyperdrive"
- sudo chmod +x /usr/local/bin/hyperdrive
- sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 6B05F25D762E3157
- hyperdrive -y --name "Landobot" --email [email protected]
- lando version
script:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Before you begin make sure you...

### Developing

You can easily get the site running locally.
You can easily get relevant web properties eg the docs and website running locally.

```bash
# Clone this repo
Expand Down
61 changes: 3 additions & 58 deletions docs/guides/improve-tandem.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,14 @@ So while _anything and everything that makes Tandem run better, faster stronger_
|-- manifesto Tandem manifesto and values
|-- templates Tandem templates
|-- README.md Documentation homepage
|-- site Follows similar structure to /docs
|-- scripts Helpful Tandem scripts
|-- .lando.yml The Landofile to power this locally and in CI
|-- .travis.yml Travis CI for build, test and deploy
|-- package.json Node dependencies and config
```

First and foremost this repo contains our manifesto, employee handbook and actionable guides to accomplish specfic things.
First and foremost this repo contains our manifesto, employee handbook and actionable guides to accomplish specfic things eg our documentation. It also contains our website and other useful toolz.

### Manifesto

Expand Down Expand Up @@ -166,63 +167,7 @@ Scripts or Lando automation that can be used on many projects can live here as w

## Suggesting a change

Suggesting a change is _very_ straightforward. [Create a new issue](https://github.com/thinktandem/tandem/issues/new/choose) and select the type of thing that best matches what you are trying to do. Then fill out the pre-populated first comment generated by the [issue template](https://help.github.com/en/articles/creating-issue-templates-for-your-repository). In a nutshell: _**that's it!**_

That said, here is a bit more context about the _kinds of things_ you can suggest.

### 1. Discussion

Discussions are a way for individuals to surface problems, concerns or ideas that should be worked on collectively. Ultimately, a discussion that is worth its salt should spawn actionable tasks that will improve the business.

That said not every task needs to be generated from a discussion. _Generally_ discussions can be used to...

1. Verify a problem
2. Validate an idea
3. Expand or hone thinking on a particular task under consideration
4. Clarify an extant policy or procedure that is confusing
5. Discuss things in a forum-like experience

However, they can and should also be used more broadly for anything that benefits from collective ideation and collaboration.

::: tip PRO TIP
You can prompt a discussion using the template in whatever way you think is best but a good format to follow if you are just starting is something like this.

1. A sentence that best describes how this particular discussion helps advance Tandem
2. A quick sketch of any initial ideas, solutions, etc you may have
3. A question to prompt comments or feedback

> Example: It's not been super reliable copying/pasting our standard set of project tickets into each new project. This is at a minimum causing a lot of internal confusion and duplicate work and at a maximum inconsistent (or nonexistant) deliverables to our clients. I'm guessing we could probably automate this process using our internal Tandem Lando plugin. Do you guys agree that is the right approach? Can you think of how we can make this as bulletproof as possible?
>
:::

### 2. Task

A task is something that is immediately actionable and _generally_ can be completed in 3 story points or less. They should seek to provide the "minimal amount of information required" so that someone else can at least _get started on_ and at most _complete_ the issue without requiring a ton of feedback.

If applicable, they should be created in pairs and linked together so that there is always a "next task" (or discussion!) to do. This ensures that we can slowly and iteratively chain multiple tasks and discussions together towards bigger goals and so that we don't lose momentum or stop improving things prematurely.

Optionally, if you have the [gift of foresight](https://yarn.co/yarn-clip/bdb49678-d85f-42fb-84cb-f48f2610876c) you should feel free to chain as many tasks together as you think makes sense. This could be 7 fully fleshed out tasks that accomplish a larger goal or it could be the minimum 2 tasks where the second task simply sketches out some _ideas_ for the next task. Caveat here is that each task you add to a chain probably diminishes in actionability and accuracy because it's likely things will change as you go through previous tasks. Try to find a good balance.

::: tip PRO TIP
Immediately actionable means that they should provide enough context and detail so that anyone can grab one and see them through to completion with minimal to zero help from others.
:::

To that end tasks can take various forms such as...

* A glorified placeholder with an obvious and simple task so that something can be tracked
* A user story with a list of action items
* A feature with a rough sketch of a technical architecture and/or implementation
* A haiku, limmerick or sonnet

They should seek to be...

* Well defined, scoped and easy to understand
* Require only a few hours of time to complete
* Immediately actionable

### 3. Note

If you just want a public place to dump some notes so that you can use them later to whatever ends then spin up a note.
Suggesting a change is _very_ straightforward. [Create a new issue](https://github.com/thinktandem/tandem/issues/new/choose) and write it up as you weill. Initially we created specific and well defined types of issues you could select from but that ended up being fairly tedious, restrictive and perhaps counter-intuitively more confusing. Our current modus operandi is to keep things open and define an issue how you like. It can be a large initiative or a simple and straightforward task, a stub with just a title or a lengthy essay. It can be whatever you want it to be! The main goal is to stay organized and get a birds eye view of what things we are doing to improve the organization.

## Managing the process

Expand Down
Loading

0 comments on commit 4e60bec

Please sign in to comment.