diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 168056d..0b4133c 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -65,10 +65,14 @@ Once the maintainers get involved, they will follow a documented series of steps You may get in touch with the maintainer team through any of the following methods: - * Email the maintainers directly at [coc@sykosomatic.org](mailto:coc@sykosomatic.org) - * Mention @zkat in a comment, or any of the other maintainers. - * Direct Message [@maybekatz](https://twitter.com/maybekatz) on Twitter with the details and any relevant links. - * Direct Message @kat in the [WeAllJS Slack Group](https://wealljs.org). + * Through email: + * [kzm@sykosomatic.org](mailto:kzm@sykosomatic.org) (Kat Marchán) + * [charlottelaspencer@gmail.com](mailto:charlottelaspencer@gmail.com) (Charlotte Spencer) + * [me@re-becca.org](mailto:me@re-becca.org) (Rebecca Turner) + + * Through Twitter: + * [@maybekatz](https://twitter.com/maybekatz) (Kat Marchán) + * [@charlotteis](https://twitter.com/charlotteis) (Charlotte Spencer) ### Further Enforcement @@ -139,7 +143,7 @@ Sometimes, though, you need to get maintainers involved. Maintainers will do the ## Attribution -This Code of Conduct is adapted from the [WeAllJS Code of +This Code of Conduct was generated using [WeAllJS Code of Conduct Generator](https://npm.im/weallbehave), which is based on the [WeAllJS Code of Conduct](https://wealljs.org/code-of-conduct), which is itself based on [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef676be..49970bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Thank you so much for your interest in contributing!. All types of contributions are encouraged and valued. See below for different ways to help, and details about how this project handles them! -Please make sure to read the relevant section before making your contribution! It will make it a lot easier for us maintainers to make the most of it and smooth out the experience fo all involved. 💚 +Please make sure to read the relevant section before making your contribution! It will make it a lot easier for us maintainers to make the most of it and smooth out the experience for all involved. 💚 The [Project Team](#join-the-project-team) looks forward to your contributions.~ @@ -24,6 +24,7 @@ The [Project Team](#join-the-project-team) looks forward to your contributions.~ * [Merge Pull Requests](#merge-pull-requests) * [Tag a Release](#tag-a-release) * [Join the Project Team](#join-the-project-team) +* [Add a Guide Like This One To My Project](#attribution) 🤖😻👻 ## Request Support @@ -233,12 +234,6 @@ TBD - need to hash out a bit more of this process. The most important bit here i ## Join the Project Team -### Current Team - -* Kat Marchán ([@zkat](https://github.com/zkat)) - Owner -* Charlotte Spencer ([@charlotteis](https://github.com/charlotteis)) - Collaborator - Commits -* Rebecca Turner ([@iarna](https://github.com/iarna)) - Collaborator - Commits - ### Ways to Join There are many ways to contribute! Most of them don't require any official status unless otherwise noted. That said, there's a couple of positions that grant special repository abilities, and this section describes how they're granted and what they do. @@ -252,3 +247,7 @@ Permission | Description Issue Tracker | Granted to contributors who express a strong interest in spending time on the project's issue tracker. These tasks are mainly [labeling issues](#label-issues), [cleaning up old ones](#clean-up-issues-and-prs), and [reviewing pull requests](#review-pull-requests), as well as all the usual things non-team-member contributors can do. Issue handlers should not merge pull requests, tag releases, or directly commit code themselves: that should still be done through the usual pull request process. Becoming an Issue Handler means the project team trusts you to understand enough of the team's process and context to implement it on the issue tracker. Committer | Granted to contributors who want to handle the actual pull request merges, tagging new versions, etc. Committers should have a good level of familiarity with the codebase, and enough context to understand the implications of various changes, as well as a good sense of the will and expectations of the project team. Admin/Owner | Granted to people ultimately responsible for the project, its community, etc. + +## Attribution + +This guide was generated using the WeAllJS `CONTRIBUTING.md` generator. [Make your own](https://npm.im/weallcontribute)! diff --git a/ISSUE_TEMPLATE b/ISSUE_TEMPLATE new file mode 100644 index 0000000..2947512 --- /dev/null +++ b/ISSUE_TEMPLATE @@ -0,0 +1,7 @@ + diff --git a/PULL_REQUEST_TEMPLATE b/PULL_REQUEST_TEMPLATE new file mode 100644 index 0000000..9471c6d --- /dev/null +++ b/PULL_REQUEST_TEMPLATE @@ -0,0 +1,7 @@ + diff --git a/package.json b/package.json index 6459483..1d87eac 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,9 @@ "preversion": "npm t", "postversion": "npm publish && git push --follow-tags", "pretest": "standard lib test *.js", - "test": "nyc -- tap test/*.js" + "test": "nyc -- tap test/*.js", + "update-coc": "weallbehave -o . && git add CODE_OF_CONDUCT.md && git commit -m 'docs(coc): updated CODE_OF_CONDUCT.md'", + "update-contrib": "weallcontribute -o . && git add CONTRIBUTING.md && git commit -m 'docs(contributing): updated CONTRIBUTING.md'" }, "repository": "https://github.com/zkat/pacote", "keywords": [ @@ -19,7 +21,22 @@ "npm", "git" ], - "author": "Kat Marchán ", + "author": { + "name": "Kat Marchán", + "email": "kzm@sykosomatic.org", + "twitter": "maybekatz" + }, + "contributors": [ + { + "name": "Charlotte Spencer", + "email": "charlottelaspencer@gmail.com", + "twitter": "charlotteis" + }, + { + "name": "Rebecca Turner", + "email": "me@re-becca.org" + } + ], "license": "CC0-1.0", "dependencies": { "cacache": "^5.0.0", @@ -42,6 +59,8 @@ "nyc": "^10.0.0", "rimraf": "^2.5.4", "standard": "^8.6.0", - "tap": "^8.0.1" + "tap": "^8.0.1", + "weallbehave": "^1.0.0", + "weallcontribute": "^1.0.7" } }