search

fsprojects / fsharp-cheatsheet

This cheatsheet aims to succinctly cover the most important aspects of F# 6.0.
http://fsprojects.github.io/fsharp-cheatsheet/
Other
327 stars 59 forks source link

feat!: try/with, string operations, primes #20

Closed SpiralOSS closed 11 months ago

SpiralOSS commented 11 months ago

@bartelink I named this PR "Updates"; and I noticed on our last PR, you changed the name and prefixed with "feat!" and named it slightly different. Is there some doco on naming practices? (Before I merge this one)

bartelink commented 11 months ago

Is there some doco on naming practices

https://www.conventionalcommits.org/en/v1.0.0/

Very annoying/wierd for about 2 days, then you can't stop yourself

TL;DR, composed of

  1. task code (e.g.: feat/chore/fix)
  2. (area) (optional)
  3. ! (if breaking)
  4. :
  5. description that does not repeat any of the previous

e.g.:

In the context of code, the ! (breaking) indicator would mean a semver interface change or a dependency on an new mandatory env var

In the context of this repo, ! would mean a subjective rewrite of something

In prod code in more normal repos:

chore(deps): Update json libs fix(Profile): Render name correctly fix(Host)!: Require DB server name via DB_SERVER_NAME

Dividing line between chore/feat/fix can be subjective

But in general feat is adding a new capability And chore is yak shaving

bartelink commented 11 months ago

I named this PR "Updates";

conventional commits also nudges toward SRP for PRs - i.e. there's no good name for this grab bag of stuff (not saying it needs to be split as long as its not in flight for long and you are the maintainer after all!)