-
Notifications
You must be signed in to change notification settings - Fork 598
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 0f6f496
Showing
3 changed files
with
290 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
<!-- # Generated by synthtool. DO NOT EDIT! !--> | ||
# 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, 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 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. | ||
|
||
This Code of Conduct also applies outside the project spaces when the Project | ||
Steward has a reasonable belief that an individual's behavior may have a | ||
negative impact on the project or its community. | ||
|
||
## Conflict Resolution | ||
|
||
We do not believe that all conflict is bad; healthy debate and disagreement | ||
often yield positive results. However, it is never okay to be disrespectful or | ||
to engage in behavior that violates the project’s code of conduct. | ||
|
||
If you see someone violating the code of conduct, you are encouraged to address | ||
the behavior directly with those involved. Many issues can be resolved quickly | ||
and easily, and this gives people more control over the outcome of their | ||
dispute. If you are unable to resolve the matter for any reason, or if the | ||
behavior is threatening or harassing, report it. We are dedicated to providing | ||
an environment where participants feel welcome and safe. | ||
|
||
Reports should be directed to *googleapis-stewards@google.com*, the | ||
Project Steward(s) for *Google Cloud Client Libraries*. It is the Project Steward’s duty to | ||
receive and address reported violations of the code of conduct. They will then | ||
work with a committee consisting of representatives from the Open Source | ||
Programs Office and the Google Open Source Strategy team. If for any reason you | ||
are uncomfortable reaching out to the Project Steward, please email | ||
opensource@google.com. | ||
|
||
We will investigate every complaint, but you may not receive a direct response. | ||
We will use our discretion in determining when and how to follow up on reported | ||
incidents, which may range from not taking action to permanent expulsion from | ||
the project and project-sponsored spaces. We will notify the accused of the | ||
report and provide them an opportunity to discuss it before any action is taken. | ||
The identity of the reporter will be omitted from the details of the report | ||
supplied to the accused. In potentially harmful situations, such as ongoing | ||
harassment or threats to anyone's safety, we may take action without notice. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, | ||
available at | ||
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# How to become a contributor and submit your own code | ||
|
||
**Table of contents** | ||
|
||
* [Contributor License Agreements](#contributor-license-agreements) | ||
* [Contributing a patch](#contributing-a-patch) | ||
* [Running the tests](#running-the-tests) | ||
* [Releasing the library](#releasing-the-library) | ||
|
||
## Contributor License Agreements | ||
|
||
We'd love to accept your sample apps and patches! Before we can take them, we | ||
have to jump a couple of legal hurdles. | ||
|
||
Please fill out either the individual or corporate Contributor License Agreement | ||
(CLA). | ||
|
||
* If you are an individual writing original source code and you're sure you | ||
own the intellectual property, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual). | ||
* If you work for a company that wants to allow you to contribute your work, | ||
then you'll need to sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate). | ||
|
||
Follow either of the two links above to access the appropriate CLA and | ||
instructions for how to sign and return it. Once we receive it, we'll be able to | ||
accept your pull requests. | ||
|
||
## Contributing A Patch | ||
|
||
1. Submit an issue describing your proposed change to the repo in question. | ||
1. The repo owner will respond to your issue promptly. | ||
1. If your proposed change is accepted, and you haven't already done so, sign a | ||
Contributor License Agreement (see details above). | ||
1. Fork the desired repo, develop and test your code changes. | ||
1. Ensure that your code adheres to the existing style in the code to which | ||
you are contributing. | ||
1. Ensure that your code has an appropriate set of tests which all pass. | ||
1. Title your pull request following [Conventional Commits](https://www.conventionalcommits.org/) styling. | ||
1. Submit a pull request. | ||
|
||
### Before you begin | ||
|
||
1. [Select or create a Cloud Platform project][projects]. | ||
1. [Enable billing for your project][billing]. | ||
1. [Enable the Cloud Life Sciences API][enable_api]. | ||
1. [Set up authentication with a service account][auth] so you can access the | ||
API from your local workstation. | ||
|
||
|
||
## Running the tests | ||
|
||
1. [Prepare your environment for Node.js setup][setup]. | ||
|
||
1. Install dependencies: | ||
|
||
npm install | ||
|
||
1. Run the tests: | ||
|
||
# Run unit tests. | ||
npm test | ||
|
||
# Run sample integration tests. | ||
npm run samples-test | ||
|
||
# Run all system tests. | ||
npm run system-test | ||
|
||
1. Lint (and maybe fix) any changes: | ||
|
||
npm run fix | ||
|
||
[setup]: https://cloud.google.com/nodejs/docs/setup | ||
[projects]: https://console.cloud.google.com/project | ||
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing | ||
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=lifesciences.googleapis.com | ||
[auth]: https://cloud.google.com/docs/authentication/getting-started |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
[//]: # "This README.md file is auto-generated, all changes to this file will be lost." | ||
[//]: # "To regenerate it, use `python -m synthtool`." | ||
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/> | ||
|
||
# [Cloud Life Sciences: Node.js Client](https://github.com/googleapis/nodejs-life-sciences) | ||
|
||
[![release level](https://img.shields.io/badge/release%20level-beta-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages) | ||
[![npm version](https://img.shields.io/npm/v/@google-cloud/life-sciences.svg)](https://www.npmjs.org/package/@google-cloud/life-sciences) | ||
[![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-life-sciences/master.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-life-sciences) | ||
|
||
|
||
|
||
|
||
lifesciences client for Node.js | ||
|
||
|
||
A comprehensive list of changes in each version may be found in | ||
[the CHANGELOG](https://github.com/googleapis/nodejs-life-sciences/blob/master/CHANGELOG.md). | ||
|
||
* [Cloud Life Sciences Node.js Client API Reference][client-docs] | ||
* [Cloud Life Sciences Documentation][product-docs] | ||
* [github.com/googleapis/nodejs-life-sciences](https://github.com/googleapis/nodejs-life-sciences) | ||
|
||
Read more about the client libraries for Cloud APIs, including the older | ||
Google APIs Client Libraries, in [Client Libraries Explained][explained]. | ||
|
||
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained | ||
|
||
**Table of contents:** | ||
|
||
|
||
* [Quickstart](#quickstart) | ||
* [Before you begin](#before-you-begin) | ||
* [Installing the client library](#installing-the-client-library) | ||
|
||
|
||
* [Versioning](#versioning) | ||
* [Contributing](#contributing) | ||
* [License](#license) | ||
|
||
## Quickstart | ||
|
||
### Before you begin | ||
|
||
1. [Select or create a Cloud Platform project][projects]. | ||
1. [Enable billing for your project][billing]. | ||
1. [Enable the Cloud Life Sciences API][enable_api]. | ||
1. [Set up authentication with a service account][auth] so you can access the | ||
API from your local workstation. | ||
|
||
### Installing the client library | ||
|
||
```bash | ||
npm install @google-cloud/life-sciences | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
The [Cloud Life Sciences Node.js Client API Reference][client-docs] documentation | ||
also contains samples. | ||
|
||
## Supported Node.js Versions | ||
|
||
Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/). | ||
Libraries are compatible with all current _active_ and _maintenance_ versions of | ||
Node.js. | ||
|
||
Client libraries targeting some end-of-life versions of Node.js are available, and | ||
can be installed via npm [dist-tags](https://docs.npmjs.com/cli/dist-tag). | ||
The dist-tags follow the naming convention `legacy-(version)`. | ||
|
||
_Legacy Node.js versions are supported as a best effort:_ | ||
|
||
* Legacy versions will not be tested in continuous integration. | ||
* Some security patches may not be able to be backported. | ||
* Dependencies will not be kept up-to-date, and features will not be backported. | ||
|
||
#### Legacy tags available | ||
|
||
* `legacy-8`: install client libraries from this dist-tag for versions | ||
compatible with Node.js 8. | ||
|
||
## Versioning | ||
|
||
This library follows [Semantic Versioning](http://semver.org/). | ||
|
||
|
||
|
||
|
||
|
||
|
||
More Information: [Google Cloud Platform Launch Stages][launch_stages] | ||
|
||
[launch_stages]: https://cloud.google.com/terms/launch-stages | ||
|
||
## Contributing | ||
|
||
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-life-sciences/blob/master/CONTRIBUTING.md). | ||
|
||
Please note that this `README.md`, the `samples/README.md`, | ||
and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`) | ||
are generated from a central template. To edit one of these files, make an edit | ||
to its template in this | ||
[directory](https://github.com/googleapis/synthtool/tree/master/synthtool/gcp/templates/node_library). | ||
|
||
## License | ||
|
||
Apache Version 2.0 | ||
|
||
See [LICENSE](https://github.com/googleapis/nodejs-life-sciences/blob/master/LICENSE) | ||
|
||
[client-docs]: https://cloud.google.com/life-sciences | ||
[product-docs]: https://cloud.google.com/life-sciences/ | ||
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png | ||
[projects]: https://console.cloud.google.com/project | ||
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing | ||
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=lifesciences.googleapis.com | ||
[auth]: https://cloud.google.com/docs/authentication/getting-started |