From 70d40fa5c95a85373427e23d6d0373280fe7269c Mon Sep 17 00:00:00 2001 From: jazibsawar Date: Thu, 29 Jun 2023 01:01:33 +0300 Subject: [PATCH] add: contributing section in readme --- .changeset/modern-llamas-hammer.md | 5 +++++ README.md | 8 ++++++++ package.json | 3 ++- 3 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 .changeset/modern-llamas-hammer.md diff --git a/.changeset/modern-llamas-hammer.md b/.changeset/modern-llamas-hammer.md new file mode 100644 index 0000000..14097a3 --- /dev/null +++ b/.changeset/modern-llamas-hammer.md @@ -0,0 +1,5 @@ +--- +'@cosmicjs/sdk': patch +--- + +Added contributing section in Readme diff --git a/README.md b/README.md index 09f663e..40fcb30 100644 --- a/README.md +++ b/README.md @@ -137,6 +137,14 @@ For additional help, you can use one of these channels to ask a question: - [Contact us](https://www.cosmicjs.com/contact) for help with any service questions and custom plan inquiries. +## Contributing + +This project uses [changeset](https://www.npmjs.com/package/@changesets/cli) to manage releases. Follow the following steps to add a changeset: + +- Run `npm run changeset` command and select type of release with description of changes. +- When PR with changeset is merged into `main` branch, Github will create a new PR with correct version change and changelog edits. +- When `codeowner` merges the generated PR, it will publish the package and create a Github release. + ## License This project is published under the [MIT](https://github.com/cosmicjs/cosmic-sdk-js/blob/HEAD/LICENSE) license. diff --git a/package.json b/package.json index 49bbb7d..162da52 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@cosmicjs/sdk", - "version": "1.0.7", + "version": "1.0.6", "description": "The official client module for Cosmic. This module helps you easily add dynamic content to your website or application using the Cosmic headless CMS.", "keywords": [ "headlesscms", @@ -33,6 +33,7 @@ "lint": "eslint --fix 'src/**/*.{ts,js}'", "format": "prettier --write './src/**/*.{ts,js}'", "release": "npm run build && changeset publish", + "changeset": "changeset", "prepare": "husky install", "prepublishOnly": "npm run build" },