create-node-lib 2.19.5 → 2.19.6

package/CHANGELOG.md

@@ -1,3 +1,5 @@
+## [2.19.6](https://github.com/lirantal/create-node-lib/compare/v2.19.5...v2.19.6) (2026-05-18)
+
 ## [2.19.5](https://github.com/lirantal/create-node-lib/compare/v2.19.4...v2.19.5) (2026-05-17)
 
 ## [2.19.4](https://github.com/lirantal/create-node-lib/compare/v2.19.3...v2.19.4) (2026-05-17)

package/__tests__/generator.test.js

@@ -13,7 +13,7 @@ describe('all the template files are accountable for', () => {
     expect(stream.fileList).toContain('.github/ISSUE_TEMPLATE/3-help.md')
     expect(stream.fileList).toContain('.github/PULL_REQUEST_TEMPLATE.md')
     expect(stream.fileList).toContain('.github/CODE_OF_CONDUCT.md')
-    expect(stream.fileList).toContain('.github/CONTRIBUTING.md')
+    expect(stream.fileList).toContain('CONTRIBUTING.md')
   })
 
   test('generator contains project files', async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-node-lib",
-  "version": "2.19.5",
+  "version": "2.19.6",
   "description": "Scaffolding out a Node.js library module",
   "bin": "./bin/cli.js",
   "engines": {

package/template/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing
+
+Thanks for taking the time to contribute! Issues, ideas, and PRs are all welcome.
+The notes below are guidelines to help your contribution land smoothly. If in doubt, open the thing anyway and we'll figure it out together.
+
+## Opening an issue
+
+A good issue gives us enough to reproduce or understand the ask. Useful things to include:
+
+- **For bugs:** what you expected, what actually happened, and the shortest repro you can manage. Versions (runtime, OS, package) and stack traces help.
+- **For features:** the problem you're trying to solve, not just the solution you have in mind. A concrete example of how you'd use it is gold.
+
+A quick search of existing issues helps avoid duplicates, but don't agonize over it.
+
+## Proposing a PR
+
+PRs are expected to meet a few baseline requirements before review:
+
+- **Tests are required** for any behavior change, new features need new tests, bug fixes need a regression test that fails without the fix.
+- **Existing tests must pass** locally and in CI. Don't disable or skip tests to make a PR green.
+- **Coverage should not regress.** If your change drops coverage meaningfully, add tests or explain why in the PR description.
+- **Linters and type checks must pass.** Run them locally before pushing; CI will reject otherwise.
+- **One logical change per PR.** Refactors, formatting churn, and unrelated fixes belong in separate PRs, it makes review and revert sane.
+- **Describe what and why.** A PR title and a few lines of context go a long way, reviewers shouldn't have to reverse-engineer your intent from the diff.
+- **Link the issue you're closing.** If your PR resolves an open issue, include a `Related issues` section in the description with `Fixes: #<issue-number>` (or `Closes: #<issue-number>`) so GitHub auto-closes it on merge.
+- **Breaking changes need a heads-up** in the PR description, plus a migration note for users.
+
+Large or speculative changes: open an issue first to align on direction before investing time.
+
+## Commit guidelines
+
+This project follows [Conventional Commits](https://www.conventionalcommits.org/). The format is:
+
+```text
+<type>(<optional scope>): <short summary>
+```
+
+Common types:
+
+- `feat:` — a new feature
+- `fix:` — a bug fix
+- `docs:` — documentation only
+- `refactor:` — code change that neither fixes a bug nor adds a feature
+- `test:` — adding or fixing tests
+- `chore:` — tooling, build, dependencies
+- `perf:` — performance improvement
+
+Examples:
+
+```text
+feat: support multiple input files
+fix(parser): handle empty input gracefully
+docs: clarify install instructions
+```
+
+Breaking changes: add `!` after the type (`feat!: ...`) and explain the break in the commit body.
+
+This format drives changelog generation and release automation, so it matters more than the average commit-style guide.
+
+## Local development
+
+1. Fork and clone the repository.
+2. Install dependencies using the project's package manager (see `package.json`, or equivalent).
+3. Run the test suite to confirm a clean baseline before making changes.
+4. Run the linter and type checker (if configured) the same way.
+5. Make your change on a feature branch, commit using the format above, and open a PR.
+
+If any of the above doesn't work on a fresh checkout, that's a bug, please open an issue.
+
+## For automated agents
+
+If you are an AI coding agent or automated bot opening a PR, please add 🤖🤖🤖 to the end of the PR title. This helps maintainers triage agent-authored contributions and is a baseline expectation for this repo — PRs without the marker that turn out to be automated may be closed without review.
+
+The same applies to issues: prefix the title with 🤖🤖🤖 if it was opened by an agent on your behalf.

package/template/README.md

@@ -33,7 +33,7 @@ const {} = require('<%= projectName %>')
 
 ## Contributing
 
-Please consult [CONTRIBUTING](./.github/CONTRIBUTING.md) for guidelines on contributing to this project.
+Please consult [CONTRIBUTING](./CONTRIBUTING.md) for guidelines on contributing to this project.
 
 ## Author
 

package/template/.github/CONTRIBUTING.md

@@ -1,32 +0,0 @@
-# Contributing
-
-:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
-
-The following is a set of guidelines for contributing to this project.
-These are mostly guidelines, not rules. Use your best judgment, and feel free
-to propose changes to this document in a pull request.
-
-## Code of Conduct
-
-This project and everyone participating in it is governed by a
-[Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to
-uphold this code.
-
-## How to contribute to this project
-
-<!-- TODO -->
-
-### Tests
-
-Make sure the code you're adding has decent test coverage.
-
-Running project tests and coverage:
-
-```bash
-npm run test
-```
-
-### Commit Guidelines
-
-The project uses the commitizen tool for standardizing changelog style commit
-and a git pre-commit hook to enforce them.