Skip to content

Commit

Permalink
docs: Copy edits and new CII badge
Browse files Browse the repository at this point in the history
Add CII badge
  • Loading branch information
jevonearth committed Sep 23, 2019
1 parent fed078e commit b5a1e2b
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 25 deletions.
16 changes: 4 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏
# Contributions

## Instructions
Please use the [GitHub issue tracker](https://github.com/ecadlabs/taquito/issues) to report bugs or request features.

These steps will guide you through contributing to this project:
To contribute, please check the issue tracker to see if an existing issue exists for your planned contribution. If there's no issue, please create one first, and then submit a pull request with your contribution.

- Fork the repo
- Clone it and install dependencies

git clone https://github.com/ecadlabs/typescript-library-starter
npm install

Keep in mind that after running `npm install` the git repo is reset. So a good way to cope with this is to have a copy of the folder to push the changes, and the other to try them.

Make and commit your changes. Make sure the commands npm run build and npm run test:prod are working.
For a contribution to be merged, it is required to have complete documentation, come with unit tests, and integration tests where appropriate. Submitting a "work in progress" pull request for review/feedback is always welcome!
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@

<span style="display:block;text-align:center">![Logo](https://tezostaquito.io/img/Taquito.png)</span>

A TypeScript library suite for development on the Tezos blockchain

[![CircleCI](https://circleci.com/gh/ecadlabs/taquito.svg?style=svg)](https://circleci.com/gh/ecadlabs/taquito)
[![codecov](https://codecov.io/gh/ecadlabs/taquito/branch/master/graph/badge.svg)](https://codecov.io/gh/ecadlabs/taquito)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3204/badge)](https://bestpractices.coreinfrastructure.org/projects/3204)

_WARNING: This project is in active development. While we welcome users and feedback, please be warned that this project is a work in progress and users should proceed with caution._
_WARNING: This project is in beta. We welcome users and feedback, please be aware that this project is a work in progress._

## What is Taquito?
## What is Taquito

Taquito is a TypeScript library suite made available as set of npm packages aiming to make building on top of Tezos easier and more enjoyable.

Expand Down Expand Up @@ -114,20 +116,18 @@ See the top-level `package.json` file. Some common targets are:

---

## Reporting Issues
## Contributions / Reporting Issues

### Security Issues

To report a security issue, please contact security@ecadlabs.com or via [keybase/jevonearth][2] on keybase.io.

Reports may be encrypted using keys published on keybase.io using [keybase/jevonearth][2].

### Other Issues & Feature Requests
### Bug or Feature Requests

Please use the [GitHub issue tracker](https://github.com/ecadlabs/taquito/issues) to report bugs or request features.

## Contributions

To contribute, please check the issue tracker to see if an existing issue exists for your planned contribution. If there's no issue, please create one first, and then submit a pull request with your contribution.

For a contribution to be merged, it is required to have complete documentation, come with unit tests, and integration tests where appropriate. Submitting a "work in progress" pull request for review/feedback is always welcome!
Expand Down
12 changes: 8 additions & 4 deletions code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,11 @@ 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 simon@ecadlabs.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.
reported by contacting the project team at frontdesk@ecadlabs.com or
[keybase/jevonearth][jev] or [keybase/simrob][simon] 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
Expand All @@ -72,3 +73,6 @@ available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

[jev]: https://keybase.io/jevonearth
[simon]: https://keybase.io/simrob
3 changes: 1 addition & 2 deletions docs/inmemory_signer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In memory signer is a local signer implementation that allows you to directly us

This signer implementation is meant to be used for development and not for production use case

## Usage
## Usage

```js

Expand All @@ -22,4 +22,3 @@ Tezos.setProvider({signer: new InMemorySigner('you_private_key')})
If you configure taquito this way you will now be able to use every function that needs signing support

`Note: Operation will be signed automatically using the signer (no prompt)`

7 changes: 6 additions & 1 deletion docs/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ author: Simon Boissonneault-Robert

## Installing the library

> For quick-start, you may also like to try out our template/boilerplate app [here][boilerplate]
The following instructions assume you have a project already created, and you have `npm` installed and operable.

```sh
npm install @taquito/taquito
```
Expand Down Expand Up @@ -58,7 +62,6 @@ Tezos.tz.getBalance('your_address')
Tezos.query.balanceHistory('your_address')
```


### Import a key

`This will import your private key in memory and will sign operation using this key automatically`
Expand Down Expand Up @@ -87,3 +90,5 @@ const operation = contract.methods.mint('tz1', 100).send({ fee: 20000 })

await operation.confirmation()
```

[boilerplate]: https://github.com/ecadlabs/taquito-boilerplate

0 comments on commit b5a1e2b

Please sign in to comment.