diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9f53c79 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, 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 within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +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 laura@semi.technology. 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 + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 0000000..42eb595 --- /dev/null +++ b/CONTRIBUTE.md @@ -0,0 +1,37 @@ +### Thanks for looking into contributing to Weaviate JavaScript client! +Contributing works pretty easy. You can do a pull request or you can commit if you are part of a Weaviate team. + +### Code of Conduct +Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) + + +### How we use Gitflow +How we use [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) and how you can contribute following a few steps. + +- The master branch is what is released and developed currently. +- You can create a feature-branch that is named: feature/YOUR-FEATURE-NAME. +- Your feature branch always has the master branch as a starting point. +- When you are done with your feature you should create a pull request into the master branch. +- The master branch is protected. + +### Tagging your commit + +Always add a reference to your issue to your git commit. + +For example: `gh-100: This is the commit message` + +AKA: smart commits + +### Pull Request + +If you create a pull request without smart commits, the pull request will be [squashed into](https://blog.github.com/2016-04-01-squash-your-commits/) one git commit. + +### Contributor License Agreement + +Contributions to Weaviate JavaScript client must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of Weaviate JavaScript client. Go to [this page](https://www.semi.technology/playbooks/misc/contributor-license-agreement.html) to read the current agreement. + +The process works as follows: + +- You contribute by opening a [pull request](#pull-request). +- If your account has no CLA, a DocuSign link will be added as a comment to the pull request. diff --git a/README.md b/README.md index 8aa97d0..7a48e56 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,11 @@ A javascript client for easy interaction with a weaviate instance. ## Support - [Stackoverflow for questions](https://stackoverflow.com/questions/tagged/weaviate). -- [Github for issues](https://github.com/semi-technologies/weaviate-python-client/issues). +- [Github for issues](https://github.com/semi-technologies/weaviate-javascript-client/issues). ## Contributing -- [How to Contribute](https://github.com/semi-technologies/weaviate/blob/master/CONTRIBUTE.md). +- [How to Contribute](https://github.com/semi-technologies/weaviate-javascript-client/blob/master/CONTRIBUTE.md). ## Build Status diff --git a/package.json b/package.json index aa59e3a..77a4a3b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "weaviate-client", - "version": "2.3.0", + "version": "2.10.0", "description": "Javascript client for Weaviate", "main": "lib.js", "scripts": { diff --git a/tools/prepare_release.sh b/tools/prepare_release.sh new file mode 100755 index 0000000..252569b --- /dev/null +++ b/tools/prepare_release.sh @@ -0,0 +1,22 @@ +#!/bin/bash + +set -euo pipefail + +VERSION="$(jq -r '.version' ./package.json)" +REQUIRED_TOOLS="jq git" + +for tool in $REQUIRED_TOOLS; do + if ! hash "$tool" 2>/dev/null; then + echo "This script requires '$tool', but it is not installed." + exit 1 + fi +done + +if git rev-parse "v$VERSION" >/dev/null 2>&1; then + echo "Cannot prepare release, a release for v$VERSION already exists" + exit 1 +fi + +git commit -a -m "prepare release v$VERSION" + +git tag -a "v$VERSION" -m "$VERSION"