Skip to content

Commit

Permalink
add: contributing section in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jazibsawar committed Jun 28, 2023
1 parent 382032f commit 70d40fa
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .changeset/modern-llamas-hammer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@cosmicjs/sdk': patch
---

Added contributing section in Readme
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down Expand Up @@ -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"
},
Expand Down

0 comments on commit 70d40fa

Please sign in to comment.