diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index a66c21b642..0000000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1 +0,0 @@ -github: ApeWorX diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 7e742be6b9..0000000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Report an error that you've encountered. -labels: 'category: bug' ---- - -### Environment information - -- OS: macOS / linux / win -- Python Version: x.x.x -- `ape` and plugin versions: - -```sh -$ ape --version -# ...copy and paste result of above command here... - -$ ape plugins list -# ...copy and paste result of above command here... -``` - -- Contents of your `ape-config.yaml` (NOTE: do not post anything private like RPC urls or secrets!): - -```sh -$ cat ape-config.yaml -# ...copy and paste result of above command here... -``` - -### What went wrong? - -Please include information like: - -- what command you ran -- the code that caused the failure (see [this link](https://help.github.com/articles/basic-writing-and-formatting-syntax/) for help with formatting code) -- full output of the error you received - -### How can it be fixed? - -Fill this in if you have ideas on how the bug could be fixed. diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000000..9768b43c78 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,49 @@ +name: Bug report +description: File a bug report +labels: 'category: bug' +body: + - type: markdown + attributes: + value: | + Please ensure that the bug has not already been filed in the issue tracker. + + Thanks for taking the time to report this bug! + - type: checkboxes + attributes: + label: Have you ensured that all of these are up to date? + options: + - label: Ape + - label: Ape plugins + - type: input + attributes: + label: What version of Ape are you on? + placeholder: "Run `ape --version` and paste the output here" + - type: input + attributes: + label: What command(s) is the bug in? + description: Leave empty if not relevant + placeholder: "For example: ape test" + - type: dropdown + attributes: + label: Operating System + description: What operating system are you on? + options: + - Windows + - macOS (Intel) + - macOS (Apple Silicon) + - Linux + validations: + required: true + - type: textarea + attributes: + label: ape-config.yaml file + description: "Please paste your `ape-config.yaml` contents here (NOTE: do not post anything private like RPC urls or secrets!)" + placeholder: "Run `cat ape-config.yaml` and copy and paste the result here" + validations: + required: true + - type: textarea + attributes: + label: Reproduction code + description: Please include a simple reproduction code-snippet. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md deleted file mode 100644 index 374749692d..0000000000 --- a/.github/ISSUE_TEMPLATE/feature.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature request -about: Request a new feature, or an improvement to existing functionality. -labels: 'category: feature' ---- - -### Overview - -Provide a simple overview of what you wish to see added. Please include: - -- What you are trying to do -- Why Ape's current functionality is inadequate to address your goal - -### Specification - -Describe the syntax and semantics of how you would like to see this feature implemented. The more detailed the better! - -Remember, your feature is much more likely to be included if it does not involve any breaking changes. - -### Dependencies - -Include links to any open issues that must be resolved before this feature can be implemented. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000000..0b6a8b6cc1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,32 @@ +name: Feature Request +description: Request a new feature, or an improvement to existing functionality. +labels: 'category: feature' + +body: + - type: textarea + id: describe + attributes: + label: Describe + description: "Provide a simple overview of what you wish to see added." + placeholder: | + I am trying to ... + Ape's current functionality is inadequate because ... + validations: + required: false + - type: textarea + id: specification + attributes: + label: Specification + description: | + Describe the syntax and semantics of how you would like to see this feature implemented. The more detailed the better! + Remember, your feature is much more likely to be included if it does not involve any breaking changes. + validations: + required: false + - type: textarea + id: dependencies + attributes: + label: Dependencies + description: | + Include links to any open issues that must be resolved before this feature can be implemented. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/work-item.md b/.github/ISSUE_TEMPLATE/work-item.md deleted file mode 100644 index 6587ddff06..0000000000 --- a/.github/ISSUE_TEMPLATE/work-item.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: Work item -about: New work item for Ape team ---- - -### Elevator pitch: - - - -### Value: - - - -### Dependencies: - - - -### Design approach: - - - -### Task list: - - - -- \[ \] Tasks go here - -### Estimated completion date: - -### Design review: - - - -Do not signoff unless: - -- 1. agreed the tasks and design approach will achieve acceptance, and -- 2. the work can be completed by one person within the SLA. - Design reviewers should consider simpler approaches to achieve goals. - -(Please leave a comment to sign off) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index d2385346b2..0000000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,23 +0,0 @@ -### What I did - - - - - -fixes: # - -### How I did it - - - -### How to verify it - - - -### Checklist - - - -- [ ] All changes are completed -- [ ] New test cases have been added -- [ ] Documentation has been updated diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 04117535c8..0000000000 --- a/SECURITY.md +++ /dev/null @@ -1,64 +0,0 @@ -# Security Policy - -This document describes the Security Policy for ApeWorX Ltd., including vulnerability disclosures for the Ape Framework, any of its maintained plugins, or any packages we maintain used by those as dependencies. -We are committed to conduct our Security Process in a professional and civil manner. -Public shaming, under-reporting, or misrepresentation of vulnerabilities will not be tolerated. - -To submit a finding, please follow the steps outlined in receiving disclosures [section](#disclosing-a-vulnerability). - -## Responsible Disclosure Standard - -ApeWorX follows a community [standard](https://github.com/RD-Crypto-Spec/Responsible-Disclosure#the-standard) for responsible disclosure in cryptocurrency and related software. -This document is a public commitment to following the standard. - -This standard provides detailed information for: - -- [Initial Contact](https://github.com/RD-Crypto-Spec/Responsible-Disclosure#initial-contact): - how to establish initial contact with our security team. -- [Giving Details](https://github.com/RD-Crypto-Spec/Responsible-Disclosure#giving-details): - what details to include with your vulnerability disclosure after having received a response to your initial contact. -- [Setting Dates](https://github.com/RD-Crypto-Spec/Responsible-Disclosure#setting-dates): - how to agree on timelines for releasing updates and making details of the issue public. - -Any expected deviations and necessary clarifications around the standard are explained in the following sections. - -## Disclosing a Vulnerability - -### Supported Versions - -Ape is currently under active development, we support the latest release by major version. -Any security issues found on the latest minor version of Ape will be fixed and released in either a patch or minor release. - -| Version | Supported | -| ------- | ------------------ | -| > 0.6.x | :white_check_mark: | - -### Directly to ApeWorX - -ApeWorX is committed to working with researchers who submit security vulnerability notifications to us, to resolve those issues on an appropriate timeline, and to perform a coordinated release, giving credit to the reporter if they would so like. - -Please submit disclosures to **all** of the following main points of contact for security related issues according to the [initial contact](https://github.com/RD-Crypto-Spec/Responsible-Disclosure#initial-contact) and [giving details](https://github.com/RD-Crypto-Spec/Responsible-Disclosure#giving-details) guidelines. - -For all security related issues, ApeWorX has the following main points of contact: - -| Contact | Keybase | -| ------------------------------------------------------ | ----------------------------------------------------------- | -| [@fubuloubu](https://github.com/fubuloubu) | [@fubuloubu](https://keybase.io/fubuloubu/chat) | -| [@NotPeopling2day](https://github.com/NotPeopling2day) | [@NotPeopling2day](https://keybase.io/notpeopling2day/chat) | -| [@unparalleled-js](https://github.com/unparalleled-js) | [@Antazoey](https://keybase.io/antazoey/chat) | - -## Sending Disclosures - -In the case where we become aware of security issues affecting projects using Ape, our intention is to engage in responsible disclosures with them as described in the adopted [standard](https://github.com/RD-Crypto-Spec/Responsible-Disclosure). - -## Bilateral Responsible Disclosure Agreements - -_ApeWorX does not currently have any established bilateral disclosure agreements._ - -## Bug Bounty Program - -_ApeWorX does not currently have any bug bounty programs._ - -## Credits - -Parts of this document were inspired by [Yearn's security policy](https://github.com/yearn/yearn-security/blob/master/SECURITY.md).