Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore/ OS-704 Add security contact to the readme(s) #470

Merged
merged 2 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,14 @@ The core smart contracts have been audited by [Halborn](https://www.halborn.com/

We'd love to hear what you think! If you want to build this with us, please find a detailed contribution guide in the `CONTRIBUTION_GUIDE.md` [file here](https://github.com/aragon/osx/blob/develop/CONTRIBUTION_GUIDE.md).

## Security

If you believe you've found a security issue, we encourage you to notify us. We welcome working with you to resolve the issue promptly.

Security Contact Email: sirt@aragon.org

Please do not use the issue tracker for security issues.

## Setup

Start by running `yarn install` in the project root in your terminal.
Expand Down
12 changes: 12 additions & 0 deletions packages/contracts-ethers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,15 @@ console.log(activeContractsList.rinkeby.TokenFactory);
- `yarn run:contracts`
- `yarn run`
- `yarn run:npm`

## Contributing

If you like what we're doing and would love to support, please review our `CONTRIBUTING_GUIDE.md` [here](https://github.com/aragon/osx/blob/develop/CONTRIBUTION_GUIDE.md). We'd love to build with you.

## Security

If you believe you've found a security issue, we encourage you to notify us. We welcome working with you to resolve the issue promptly.

Security Contact Email: sirt@aragon.org

Please do not use the issue tracker for security issues.
8 changes: 8 additions & 0 deletions packages/contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,14 @@ You can find all documentation regarding how to use this protocol in [Aragon's D

If you like what we're doing and would love to support, please review our `CONTRIBUTING_GUIDE.md` [here](https://github.com/aragon/osx/blob/develop/CONTRIBUTION_GUIDE.md). We'd love to build with you.

## Security

If you believe you've found a security issue, we encourage you to notify us. We welcome working with you to resolve the issue promptly.

Security Contact Email: sirt@aragon.org

Please do not use the issue tracker for security issues.

## Etherscan verification

To try out Etherscan verification, you first need to deploy a contract to an Ethereum testnet that's supported by Etherscan, such as [goerli](https://goerli.etherscan.io) or [sepolia](https://sepolia.etherscan.io).
Expand Down
23 changes: 19 additions & 4 deletions packages/subgraph/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ You have the option to deploy your subgraph locally, this is how you can do it.

Make sure u set the env variable `<NETWORK_NAME>` to 'localhost' and `<SUBGRAPH_NAME>` to 'aragon/aragon-core'.

To update the local manifest after the contracts have been compiled,
To update the local manifest after the contracts have been compiled,

```console
yarn updateLocalManifest
```
Expand All @@ -81,11 +82,13 @@ To start:
yarn start:dev
```

When there's changes in the contract's package, run
When there are changes in the contract's package, run

```console
yarn buildAndStart:dev
```
to force build the hardhat docker image containing the contracts.
```

to force build the hardhat docker image containing the contracts.

Ideally in the future, the docker image should be part of the contract's CI/CD flow. Each time a new version of contracts is released, a new docker image should also be released, and the version number should be changed on the docker-compose in the subgraph directory.

Expand All @@ -111,3 +114,15 @@ yarn stop:dev
| subgraph:patch | Applies a patch version bump for the changelog and package.json |
| subgraph:minor | Applies a minor version bump for the changelog and package.json |
| subgraph:major | Applies a major version bump for the changelog and package.json |

## Contributing

If you like what we're doing and would love to support, please review our `CONTRIBUTING_GUIDE.md` [here](https://github.com/aragon/osx/blob/develop/CONTRIBUTION_GUIDE.md). We'd love to build with you.

## Security

If you believe you've found a security issue, we encourage you to notify us. We welcome working with you to resolve the issue promptly.

Security Contact Email: sirt@aragon.org

Please do not use the issue tracker for security issues.