dev process && CHANGE.log First Pass

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+closes #issue
+
+<!-- PLEASE FILL THIS OUT BELLOW -->
+- [ ] Do you think code didn't change in this PR?
+- [ ] Did you include an issue for this PR
+- [ ] Did you write test for this PR?
+<!-- if not please explain how it was tested -->
+- [ ] Did you write documentation in some form for this PR?
+<!-- inline docs or read me? please explain why you didnt check that box-->
+- [ ] Did you request a reviewer for this PR that did not include commits?
+<!-- if you did select someone who did pick some one else -->
+- [ ] Did this get QA'd by someone else
+<!-- if this is going into main this box ^ must be checked -->
+- [ ] Did you include a CHANGELOG.md entry?

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format extends [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+**At the moment this project DOES NOT adhere to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).**
+
+**Until MAJOR version 1; All MINOR versions are breaking changes and all patch versions are bug fixes and features.**
+
+Version header format: `[version] Name - year-month-day (entropy-core compatibility: version [range])`
+
+## [UNRELEASED]
+
+### Added
+
+### Fixed
+
+### Changed
+
+### Broke
+
+### Meta/Dev
+- new: `./dev/README.md`
+- `./.github`: their is now a check list you should fill out for creating a PR

dev/README.md

@@ -0,0 +1,46 @@
+# Hello sdk dev!
+
+## Tests
+
+DONT HAVE ANY YET LETS MAKE SOME!
+
+## Linting
+
+We've got automated linting set up as a pre-commit hook.
+Setup
+
+- dependencies: `husky`, `pinst`, `lint-staged`
+- files: `.husky/`
+
+If you are blocked from committing, you can skip these hooks
+
+```bash
+git commit --no-verify
+```
+
+### A note on PR's
+
+- Please check all relevant boxes in pr template
+- Please select an appropriate reviewer.
+   - PR's that have the reviewer also contribute code will either not be merged in or they might get reverted.
+- PR for `dev` -> `main`
+   - must have:
+      - [ ] two QA approvals one from `js team` one from `dev rel`
+      - [ ] comprehensive coverage of change log
+
+## Publishing all included
+
+
+Always publish from `main` branch
+
+```bash
+git checkout main
+yarn burn
+yarn
+yarn bundle
+yarn version --patch # patch|minor|major
+# npm publish # we are not live yet on npm do this when we have global install figured out
+git push origin main --tags
+```
+
+go create a release on github if possible.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@entropyxyz/cli",
-  "version": "1.0.0",
-  "description": "",
+  "version": "0.0.1",
+  "description": "cli and tui for interacting with the entropy protocol",
   "scripts": {
     "start": "ts-node src/index.ts",
     "start:debug": "DEBUG=@entropyxyz/cli yarn start",
@@ -22,7 +22,7 @@
     "url": "git+https://github.com/entropyxyz/cli.git"
   },
   "keywords": [],
-  "author": "Jesse Abramowitz",
+  "author": "entropy.xyz",
   "license": "AGPL-3.0-only",
   "bugs": {
     "url": "https://github.com/entropyxyz/cli/issues"