From ac3be5e41752c96432518ea684e7c65da0875443 Mon Sep 17 00:00:00 2001 From: Frankie Date: Wed, 12 Jun 2024 08:01:36 -1000 Subject: [PATCH 1/8] fix author & version: 0.0.1 (#99) --- package.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index da2cd977..61d6a07d 100644 --- a/package.json +++ b/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" From 02ccd4c4793329b2efc16e0ec6f5f85535d15cb8 Mon Sep 17 00:00:00 2001 From: frankie Date: Wed, 12 Jun 2024 08:24:15 -1000 Subject: [PATCH 2/8] go back --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 61d6a07d..b8f0f192 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@entropyxyz/cli", - "version": "0.0.1", + "version": "0.0.0", "description": "cli and tui for interacting with the entropy protocol", "scripts": { "start": "ts-node src/index.ts", From 60235cf832a922e4e322d72579e9c6e374070a0f Mon Sep 17 00:00:00 2001 From: frankie Date: Wed, 12 Jun 2024 08:24:53 -1000 Subject: [PATCH 3/8] 0.0.1 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b8f0f192..61d6a07d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@entropyxyz/cli", - "version": "0.0.0", + "version": "0.0.1", "description": "cli and tui for interacting with the entropy protocol", "scripts": { "start": "ts-node src/index.ts", From 4fb3fdf00efa95aa1708b03a386019e0f1508ed8 Mon Sep 17 00:00:00 2001 From: frankie Date: Wed, 12 Jun 2024 13:20:09 -1000 Subject: [PATCH 4/8] pr template --- .github/PULL_REQUEST_TEMPLATE.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..77460996 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ + + + + + + +- [ ] 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? + +- [ ] Did you write documentation in some form for this PR? + +- [ ] Did you request a reviewer for this PR that did not include commits? + +- [ ] Did this get QA'd by someone else + +- [ ] Did you include a CHANGELOG.md entry? \ No newline at end of file From 86730517a1679659ba042cb8d1140f41dbe17492 Mon Sep 17 00:00:00 2001 From: frankie Date: Wed, 12 Jun 2024 13:32:39 -1000 Subject: [PATCH 5/8] init: CHANGELOG.md and add to it --- CHANGELOG.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..c2cac619 --- /dev/null +++ b/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 From f325b247be8e073587109927f58aa49a76d43c37 Mon Sep 17 00:00:00 2001 From: frankie Date: Wed, 12 Jun 2024 13:33:20 -1000 Subject: [PATCH 6/8] init: sugesstions for development --- dev/README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 dev/README.md diff --git a/dev/README.md b/dev/README.md new file mode 100644 index 00000000..ba633b34 --- /dev/null +++ b/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. From 0e09c3fd3a1d52bf637f28f106bdf92916cd0578 Mon Sep 17 00:00:00 2001 From: frankie Date: Wed, 12 Jun 2024 13:50:40 -1000 Subject: [PATCH 7/8] update template --- .github/PULL_REQUEST_TEMPLATE.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 77460996..797582c9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,4 @@ - - - - +closes #issue - [ ] Do you think code didn't change in this PR? From 7140dbf94a557fe2fe46b180eb33f957501f59c4 Mon Sep 17 00:00:00 2001 From: johnnymatthews <9611008+johnnymatthews@users.noreply.github.com> Date: Wed, 19 Jun 2024 09:24:36 -0300 Subject: [PATCH 8/8] Matches PR template with that in the SDK. --- .github/PULL_REQUEST_TEMPLATE.md | 50 +++++++++++++++++++++++--------- 1 file changed, 36 insertions(+), 14 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 797582c9..2b66e7c9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,36 @@ -closes #issue - - -- [ ] 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? - -- [ ] Did you write documentation in some form for this PR? - -- [ ] Did you request a reviewer for this PR that did not include commits? - -- [ ] Did this get QA'd by someone else - -- [ ] Did you include a CHANGELOG.md entry? \ No newline at end of file + + +## Related Issue(s) + + +- Resolves #[issue_number] + +## Proposed Changes + + +- Change 1 +- Change 2 +- ... + +## Testing + + +- [ ] Unit tests added/updated +- [ ] Integration tests added/updated +- [ ] Manual testing performed + +## Screenshots (if applicable) + + +## Additional Context + + +## Checklist + + +- [ ] I have performed a self-review of my code. +- [ ] I have added tests. +- [ ] I have commented my code. +- [ ] I have included a `CHANGELOG.md` entry. +- [ ] I have updated documentation in `github.com:entropyxyz/entropy-docs`, where necessary. +