diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..2b66e7c9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ + + +## 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. + 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 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. diff --git a/package.json b/package.json index 98ab60f4..dace83b0 100644 --- a/package.json +++ b/package.json @@ -36,7 +36,6 @@ "entropy protocol" ], "author": "entropy.xyz", - "license": "AGPL-3.0-only", "bugs": { "url": "https://github.com/entropyxyz/cli/issues"