🔀 Merge branch 'devel' into release

- 🔧 'clean' is made to be invoked after 'publish'
- 🩹 'lib/index.ts' is added
- 🔧 'lint' is made to be invoked before 'build'
- 💚 'paths-ignore' section is added for GitHub CI
- 📝 CONTRIBUTING.md is added
- 📝 README.md is updated
  - contributions section is added
  - license section is added
- 💚 Step to report code coverages is renamed

Signed-off-by: kei-g <km.8k6ce+github@gmail.com>

Author: kei-g

.github/workflows/main.yml

@@ -57,7 +57,7 @@ jobs:
         if: ${{ always() }}
         uses: actions/upload-artifact@v2
         with:
-          name: code-coverage-report-${{ matrix.node }}
+          name: code-coverage-report-${{ github.event.repository.name }}-${{ matrix.node }}
           path: coverage
   example:
     continue-on-error: true
@@ -112,3 +112,10 @@ on:
       - devel
       - main
       - release
+    paths-ignore:
+      - '**.md'
+      - '.editorconfig'
+      - '.gitignore'
+      - '.npmignore'
+      - '.travis.yml'
+      - 'LICENSE'

CHANGELOG.md

@@ -1,5 +1,17 @@
 # ChangeLogs
 
+## Version 1.0.10
+
+- :wrench: 'clean' is made to be invoked after 'publish'
+- :adhesive_bandage: 'lib/index.ts' is added
+- :wrench: 'lint' is made to be invoked before 'build'
+- :green_heart: 'paths-ignore' section is added for GitHub CI
+- :memo: CONTRIBUTING.md is added
+- :memo: README.md is updated
+  - contributions section is added
+  - license section is added
+- :green_heart: Step to report code coverages is renamed
+
 ## Version 1.0.9
 
 - :wrench: 'engines' section is added to 'package.json'

CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at km.8k6ce+github@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -60,6 +60,18 @@ async function example(): Promise<void> {
 example()
 ```
 
+## Lincense
+
+The scripts and documentation in this project are released under the [BSD-3-Clause License](https://github.com/kei-g/async-iterable-queue/blob/main/LICENSE)
+
+## Contributions
+
+Contributions are welcome! See [Contributor's Guide](https://github.com/kei-g/async-iterable-queue/blob/main/CONTRIBUTING.md)
+
+### Code of Conduct
+
+:clap: Be nice. See [our code of conduct](https://github.com/kei-g/async-iterable-queue/blob/main/CODE_OF_CONDUCT.md)
+
 [depencency-image]:https://img.shields.io/librariesio/release/npm/async-iterable-queue?logo=nodedotjs
 [dependency-url]:https://npmjs.com/package/async-iterable-queue?activeTab=dependencies
 [github-test-image]:https://github.com/kei-g/async-iterable-queue/actions/workflows/main.yml/badge.svg?branch=main

package.json

@@ -43,13 +43,14 @@
   },
   "repository": "github:kei-g/async-iterable-queue",
   "scripts": {
-    "build": "npm-run-all -p clean lint -p build:bundle build:tsc",
+    "build": "run-p build:bundle build:tsc",
     "build:bundle": "esbuild src/index.ts --bundle --minify --outfile=index.js --platform=node --target=ES2015",
     "build:tsc": "tsc",
     "clean": "rimraf .nyc_output/ coverage/ index.d.ts index.js lib/",
     "cover": "nyc --check-coverage -r html -r text _mocha",
     "lint": "eslint src/**/*.ts",
-    "prebuild": "run-s clean",
+    "postpublish": "run-s clean",
+    "prebuild": "run-p clean lint",
     "prepublishOnly": "run-s build",
     "start": "ts-node example.ts",
     "test": "run-p lint cover"

src/index.ts

@@ -1,3 +1,3 @@
 export const name = 'async-iterable-queue'
 
-export * from './lib/async-iterable-queue'
+export * from './lib'

src/lib/index.ts

@@ -0,0 +1 @@
+export * from './async-iterable-queue'