Skip to content

Commit

Permalink
docs: update contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KnowsCount committed Mar 16, 2022
1 parent 67f3533 commit 73926f2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
8 changes: 3 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

as said in [README.md](https://github.com/KnowsCount/contribution-heatmap/blob/main/README.md#%EF%B8%8F-contributing), resolving issues or eliminating bugs in the repository will be highly appreciated 🎉. also, feel free to share your ideas in the [discussions page](https://github.com/KnowsCount/contribution-heatmap/discussions).

below will be rules one has to follow when contributing to the repository:
below will be rules one has to bear in mind should he contribute to the repository:

## Useful Commands
## useful commands

```bash
# install deps
Expand All @@ -23,7 +23,7 @@ yarn build:major
# if anything goes wrong you can still run
yarn build

# testing
# testing (jest)
yarn test

# lint code (prettier)
Expand All @@ -38,8 +38,6 @@ an important thing to note is the code status behind patch, minor and major vers

you can read more about semantic versioning [here](https://docs.npmjs.com/about-semantic-versioning).

currently I am not following semantic versioning, but this will not be the case after release `v1.0.0`.

## commit style

please follow [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/) style. it is, so says conventionalcommits.org:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "contribution-heatmap",
"version": "1.2.0",
"version": "1.3.2",
"description": "a github-inspired react contribution heatmap component",
"scripts": {
"test": "jest",
Expand Down

1 comment on commit 73926f2

@vercel
Copy link

@vercel vercel bot commented on 73926f2 Mar 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.