diff --git a/README.md b/README.md index d82338ab9..05819c099 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/packages/contracts-ethers/README.md b/packages/contracts-ethers/README.md index 8f4612b10..70c207b03 100644 --- a/packages/contracts-ethers/README.md +++ b/packages/contracts-ethers/README.md @@ -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. diff --git a/packages/contracts/README.md b/packages/contracts/README.md index f1e921489..91b96730c 100644 --- a/packages/contracts/README.md +++ b/packages/contracts/README.md @@ -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). diff --git a/packages/subgraph/README.md b/packages/subgraph/README.md index e59c5fb20..0b4d58057 100644 --- a/packages/subgraph/README.md +++ b/packages/subgraph/README.md @@ -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 `` to 'localhost' and `` 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 ``` @@ -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. @@ -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.