From 85ccd684f0a210bc17d6b8261daa71732864c818 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Mon, 16 Oct 2017 14:29:28 -0400 Subject: [PATCH 1/3] docs: adding community docs --- CODE_OF_CONDUCT.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 8 +++++ 2 files changed, 81 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..eb640cf --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,73 @@ +# Contributor Covenant 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 richard.littauer@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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4fd506e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Contribute + +Please contribute! Here are some things that would be great: +- Open an issue! +- Open a pull request! +- Say hi! :wave: + +Please abide by the [code of conduct](CODE_OF_CONDUCT.md). From 6747a9a1d99b1cd777a84fdc8f30d80552fc06e3 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Mon, 16 Oct 2017 14:29:30 -0400 Subject: [PATCH 2/3] chore: updated fields in the package.json - [ ] Check that nothing drastic happened in the `package.json`. - [ ] Check the `package.json` keywords. We added some from your GitHub topics. - [ ] Add these keywords (from your `package.json` as GitHub topics to your repo: "ipc", "javascript", "kalm", "multiplexing", "network", "node", "optimize", "socket", "tcp", "udp", "websockets", "client", "server", "service", "peer", "micro", "latency", "messaging", "queue", "nagle", "buffer", "protocol", "web". - [ ] Check that the bugs field in the package.json is OK. It doesn't match what we'd expect, which would be https://github.com/kalm/kalm.js/issues - [ ] Update the license in your `package.json`. It did not match what we found on GitHub, and we were unable to resolve this. - [ ] We expected the repository url in the `package.json` to be https://github.com/kalm/kalm.js, and it wasn't. Is this intentional? - [ ] If there are more contributors, add them to the Contributors field in the `package.json`. --- package.json | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 85deb66..61d5946 100644 --- a/package.json +++ b/package.json @@ -7,25 +7,33 @@ "test": "mocha tests/unit --recursive && mocha tests/integration", "bench": "node tests/benchmarks" }, - "engines": { "node" : ">=6.0.0" }, + "engines": { + "node": ">=6.0.0" + }, "repository": { "type": "git", "url": "git+https://github.com/kalm/kalm-js.git" }, "keywords": [ + "ipc", + "javascript", + "kalm", + "multiplexing", + "network", + "node", + "optimize", "socket", "tcp", "udp", + "websockets", "client", "server", "service", "peer", "micro", "latency", - "ipc", "messaging", "queue", - "kalm", "nagle", "buffer", "protocol", @@ -49,5 +57,8 @@ "net": false, "fs": false, "dgram": false - } -} + }, + "contributors": [ + "frederic charette " + ] +} \ No newline at end of file From c429f21a99b46874a555ae0dadfde9d382d73cb4 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Mon, 16 Oct 2017 15:20:21 -0400 Subject: [PATCH 3/3] Edit email and homepage --- CODE_OF_CONDUCT.md | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index eb640cf..0849b8e 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -55,7 +55,7 @@ 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 richard.littauer@gmail.com. All +reported by contacting the project team at fredericcharette@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. diff --git a/package.json b/package.json index 61d5946..a7f277b 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "bugs": { "url": "https://github.com/kalm/kalm-js/issues" }, - "homepage": "https://github.com/kalm/kalm-js#readme", + "homepage": "https://kalm.js.org", "dependencies": { "debug": "~3.1.0" },