Skip to content

Commit fd556ea

Browse files
committed
docs: remove outdated contributing policy
closes #136
1 parent d5a7990 commit fd556ea

File tree

3 files changed

+4
-26
lines changed

3 files changed

+4
-26
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Version check
2+
23
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
4+
35
[![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors-)
6+
47
<!-- ALL-CONTRIBUTORS-BADGE:END -->
58

69
You can use this GitHub action to check whether your npm package version has been updated: this can be extremely helpful if you want to automate your release process.
@@ -20,7 +23,6 @@ You have to set up a step like this in your workflow (this assumes you've alread
2023
uses: EndBug/version-check@v1 # You can choose the version/branch you prefer.
2124

2225
with: # All these parameters are optional, check their descriptions to see if you need them.
23-
2426
# Whether to search in every commit's diff.
2527
# This is useful if you often do change the version without saying it in the commit message. If you always include the semver of the new version in your commit message when you bump versions then you can omit this.
2628
# Default: false
@@ -98,6 +100,7 @@ You can also find a more in-depth guide in this [here](doc/auto-publish-walkthro
98100
### Static-checking with your latest version on NPM
99101

100102
If you want to check whether the version has changed since your last published version on NPM, you can do it using `file-url` and `static-checking`:
103+
101104
- `file-url`: you need to use something like a raw.githubusercontent.com or unpkg.com URL, an API that will give you a JSON response with your package file.
102105
- `static-checking`: you're expecting your last published version to be older than the one in your repo, so we'll use `localIsNew`
103106

@@ -111,10 +114,6 @@ If you want to check whether the version has changed since your last published v
111114

112115
This step will have a `true` `changed` output every time our version is newer (there won't be any `commit` output).
113116

114-
## Contributing
115-
116-
If you want to contribute to the action, even by just raising a problem or proposing an idea, you can click [here](CONTRIBUTING.md) to find out how to do it ;)
117-
118117
## Contributors ✨
119118

120119
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

package-lock.json

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)