Installations

npm install weallcontribute

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

10.15.3

NPM Version

6.9.1-next.0

Pull Requests

Open

11

Total

43

Closed

11

Merged

21

Issues

Open

4

Total

6

Closed

2

Releases

Unable to fetch releases

Contributors

7

Unable to fetch Contributors

View all 7 contributors

Languages

1

JavaScript

JavaScript (100%)

Developer

wealljs

Download Statistics

Total Downloads

103,923

Last Day

16

Last Week

77

Last Month

491

Last Year

12,525

GitHub Statistics

166 Stars

42 Commits

36 Forks

8 Watching

6 Branches

7 Contributors

Bundle Size

159.74 kB

Minified

48.92 kB

Minified + Gzipped

Bundlephobia

Maintainers

2

Package Meta Information

Latest Version

1.0.9

Package Id

weallcontribute@1.0.9

Size

13.02 kB

NPM Version

6.9.1-next.0

Node Version

10.15.3

Publised On

07 Jun 2019

Total Downloads

Cumulative downloads

Total Downloads

103,923

Last day

60%

16

Compared to previous day

Last week

-48.3%

77

Compared to previous week

Last month

24%

491

Compared to previous month

Last year

42.4%

12,525

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

2

hosted-git-info yargs

Dev Dependencies

4

nyc standard tap weallbehave

Versions

weallcontribute

weallcontribute is a command-line tool for automatically generating and updating CONTRIBUTING.md guidelines for your projects.

Install

Locally to your npm project (recommended):

$ npm install --save-dev weallcontribute

Globally:

$ npm install -g weallcontribute

Example

npm repo

1// package.json
2{
3  "scripts": {
4    "update-contrib": "weallcontribute -o . && git add CONTRIBUTING.md && git commit -m 'docs(contributing): updated CONTRIBUTING.md'"
5  }
6}
7// Now you can do `npm run update-contrib` any time you
8// bump your `weallcontribute` version to bring your docs
9// up to date! And you don't need a global install!

Global CLI install

1# Read your repo info from package.json or git
2# and pipe the output to `contribs.md`
3$ weallcontribute > contribs.md
4
5# Write a CONTRIBUTING.md document for org/proj to the ./foo dir.
6$ weallcontribute org/proj -o ./foo

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2

/10

Last Scanned on 2025-01-20

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More