chore(contributing): add file [skip ci]

gadicc · Feb 2, 2021 · 1236602 · 1236602
1 parent 0d5c9d9
commit 1236602
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,21 @@
+# Contributing to yahoo-finance2
+
+## Development Guidelines
+
+**Default branch: devel**
+
+All PRs should be submitted against the `devel` branch (github default).
+
+**Changing TypeScript Interfaces**
+
+Run `yarn generateSchema` after changing any interfaces, this will regenerate
+the `schema.json` file which is used for run-time tests.
+
+**Commit Messages**
+
+Commit messages should follow the
+[conventionalcommits](https://www.conventionalcommits.org/) standard
+(basically Angular).  This is important as we use
+[semantic-release](https://github.com/semantic-release/semantic-release)
+to automate releases and [CHANGELOG](./CHANGELOG.md) entries when we merge
+back to master.