deft/journal/2020-11-26--10-11-23Z--meta_rfc_for_dev_team.org
2020-11-26 10:43:59 +01:00

1.7 KiB

Meta RFC for dev team

tags :: work organisation source ::

Yesterday in our weekly meeting I discussed about how I would like us to work with RFCs.

I would like to add this document to talk about how we should use RFCs. So this is a meta document. I hope not to trigger the need for a meta-meta-document ;).

Problem

We do not have proper RFC template. Developer focused RFCs and Feature specification RFC should probably have distinct templates.

Proposed Solutions

Here are my proposed templates. We already have a dev label we should probably use for RFC meaningful only for developpers, and we should continu to use the Epic label for issues whose goal is the provide a spcecification document that we could give to Managers with an Execution Plan.

Template Dev

This is the template I think we should use for everything regarding:

  • coding conventions
  • code tools
  • code refactorisations
  • code architecture
  • code cleaning
# [Title] <- name of the issue in github

Abstract: A little bit more than in the title

Kind*:
   + code convention
     - ns naming convention
     - position of args
     - naming of args
     - etc..
   + dev tooling
     - emacs mode
     - cider
     - clj-refactor
     - CI
     - scripts
     - git commit message
     - docker
     - etc...
   + technical specification
     - goal write a document for other dev (potential other teams), managers, and provide an execution plan

## Objective

## Solution