Gathering detailed insights and metrics for contributing-gen
Installations
npm install contributing-genDeveloper Guide
BETA
Typescript
No
Module System
ESM
Node Version
21.5.0
NPM Version
10.3.0
Score
67.3
Supply Chain
86.1
Quality
75.7
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Contributors
6
Unable to fetch Contributors
Languages
1
JavaScript
JavaScript (100%)
Developer
Download Statistics
Total Downloads
1,551
Last Day
1
Last Week
11
Last Month
32
Last Year
317
GitHub Statistics
83 Stars
44 Commits
19 Forks
2 Watching
1 Branches
6 Contributors
Bundle Size
3.87 kB
Minified
1.67 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
1.0.3
Package Id
contributing-gen@1.0.3
Unpacked Size
38.32 kB
Size
9.00 kB
File Count
11
NPM Version
10.3.0
Node Version
21.5.0
Publised On
13 Jan 2024
Total Downloads
Cumulative downloads
Total Downloads
1,551
Last day
-83.3%
1
Compared to previous day
Last week
57.1%
11
Compared to previous week
Last month
60%
32
Compared to previous month
Last year
-49.1%
317
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Versions
Welcome to contributing-gen
A CONTRIBUTING.md generator - A guideline to communicate how people should contribute to your project.
Generate it directly in your browser with the web frontend (contributing-gen-web). 🎉
The generated artifacts should serve as basis, adviser and inspiration. We do not guarantee completeness, but a good starting point for a well-structured guide.
Getting Started
- Clone this repository
- Open the terminal, cd to the project folder and run
npm install - Open the
generate.jsfile and update it with your project information - Run
npm run gento generate new files
The files have now been generated and you can copy them into your project repository. And don't forget to mention them in your readme.
In the following listing you see the specification, which you have to fill with your information:
1const specs = { 2 project: { 3 name: "XYZ", 4 defaultBranch: "main", 5 repoUrl: "https://github.com/user/project-slug/", 6 docsUrl: "https://github.com/user/project-slug/blob/main/README.md", 7 }, 8 contributing: { 9 generate: true, 10 emailSensitiveBugs: "security@example.com", 11 }, 12 codeOfConduct: { 13 generate: true, 14 // enforcement email must not be omitted if 'generate' is true 15 enforcementEmail: "email@example.com", 16 // additional info about how the code of conduct will be enforced 17 enforcementGuidelines: false, 18 }, 19};
Contributing
Although this project should serve as a good example, we don't have an extra guideline for contributions, since the project has a small scope without any programming. Nevertheless, anyone who wants to participate, in whatever form, must follow our Code of Conduct.
Everyone who has ideas and suggestions for improvement is encouraged to contribute. Be it with a simple issue or a pull request. Our goal is to create the best template for contribution guidelines, which helps every open source developer to create an individual guide. It should be made clear to project owners how comprehensible and simple guidelines are structured and how to encourage the community to participate in the project. And don't hesitate, even if it is just a small typo you have spotted.
The community looks forward to your contributions. 🤩
License
contributing-gen is released under the MIT License.
Acknowledgment
For the templates we have looked at several open source projects:
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
Found 5/21 approved changesets -- score normalized to 2
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 14 are checked with a SAST tool
Score
3.8
/10
Last Scanned on 2025-01-27
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