From 11adf4675dc5d74cf894dc1102e21362a728f965 Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Wed, 11 Sep 2024 12:32:39 -0500 Subject: [PATCH 01/11] docs: make easier to provider repro steps --- .github/ISSUE_TEMPLATE/bug.md | 38 ---------------------------- .github/ISSUE_TEMPLATE/bug.yml | 46 ++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 38 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml 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..89c74acf63 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,46 @@ +name: Bug report +description: File a bug report +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 + - type: textarea + attributes: + label: Ape config 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: Reproduce the bug + description: Please include a simple reproduction snippet. + validations: + required: true From 58d2d73298b592ecea524e55e13ce5f63c718e3d Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Wed, 11 Sep 2024 13:06:28 -0500 Subject: [PATCH 02/11] docs: migrate rest --- .github/ISSUE_TEMPLATE/bug.yml | 85 ++++++++++++++-------------- .github/ISSUE_TEMPLATE/feature.md | 22 ------- .github/ISSUE_TEMPLATE/feature.yml | 32 +++++++++++ .github/ISSUE_TEMPLATE/work-item.md | 47 --------------- .github/ISSUE_TEMPLATE/work-item.yml | 51 +++++++++++++++++ 5 files changed, 126 insertions(+), 111 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/feature.yml delete mode 100644 .github/ISSUE_TEMPLATE/work-item.md create mode 100644 .github/ISSUE_TEMPLATE/work-item.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 89c74acf63..9260483fd0 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,46 +1,47 @@ 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. + - 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 - - type: textarea - attributes: - label: Ape config 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: Reproduce the bug - description: Please include a simple reproduction snippet. - validations: - required: true + 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 + - type: textarea + attributes: + label: Ape config 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: Reproduce the bug + description: Please include a simple reproduction 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..d046702186 --- /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: input + id: describe + attributes: + label: Describe + description: "Provide a simple overview of what you wish to see added. Please include:" + placeholder: | + - What you are trying to do + - Why Ape's current functionality is inadequate to address your goal + validations: + required: false + - type: input + 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: input + 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/ISSUE_TEMPLATE/work-item.yml b/.github/ISSUE_TEMPLATE/work-item.yml new file mode 100644 index 0000000000..0cc4694d5b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/work-item.yml @@ -0,0 +1,51 @@ +name: Work Item +description: New work item for Ape team +body: + - type: input + id: pitch + attributes: + label: Evelator Pitch + placeholder: 1-2 line summary of the scope of this work item + - type: input + id: value + attributes: + label: Value + placeholder: | + Who is this for? + Persona or group of people whom will derive value from the scenario. + What benefits will be achieved or business metrics improved? + - type: input + id: dependencies + attributes: + label: Dependencies + placeholder: | + Call out key people, teams, tech dependencies, or assumptions. + - type: input + id: approach + attributes: + label: Design Approach + placeholder: | + Free text / diagram / whiteboard picture / etc. that clearly shows your approach and considerations to build the task list. + Existing code patterns in production code base that you will base your work off of. + - type: input + id: tasks + attributes: + label: Task List + description: Bulleted list describing the exit criteria, desired end state and any documentation, monitors, work for DRI, etc. that will need to be added to make sure someone else can support once it's live. + placeholder: \[\] Tasks go here + - type: input + id: date + attributes: + label: Estimated Completion Date + - type: input + id: review + attributes: + description: 1-2 people needed for signoff + label: | + 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) From 1c023462422bcfbf3a44b7020c6574a400934a52 Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Wed, 11 Sep 2024 13:15:16 -0500 Subject: [PATCH 03/11] docs: types fixes --- .github/ISSUE_TEMPLATE/feature.yml | 6 +++--- .github/ISSUE_TEMPLATE/work-item.yml | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index d046702186..c8443198c4 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -3,7 +3,7 @@ description: Request a new feature, or an improvement to existing functionality. labels: 'category: feature' body: - - type: input + - type: textarea id: describe attributes: label: Describe @@ -13,7 +13,7 @@ body: - Why Ape's current functionality is inadequate to address your goal validations: required: false - - type: input + - type: textarea id: specification attributes: label: Specification @@ -22,7 +22,7 @@ body: Remember, your feature is much more likely to be included if it does not involve any breaking changes. validations: required: false - - type: input + - type: textarea id: dependencies attributes: label: Dependencies diff --git a/.github/ISSUE_TEMPLATE/work-item.yml b/.github/ISSUE_TEMPLATE/work-item.yml index 0cc4694d5b..7a8aa1cbdb 100644 --- a/.github/ISSUE_TEMPLATE/work-item.yml +++ b/.github/ISSUE_TEMPLATE/work-item.yml @@ -1,7 +1,7 @@ name: Work Item description: New work item for Ape team body: - - type: input + - type: textarea id: pitch attributes: label: Evelator Pitch @@ -14,30 +14,30 @@ body: Who is this for? Persona or group of people whom will derive value from the scenario. What benefits will be achieved or business metrics improved? - - type: input + - type: textarea id: dependencies attributes: label: Dependencies placeholder: | Call out key people, teams, tech dependencies, or assumptions. - - type: input + - type: textarea id: approach attributes: label: Design Approach placeholder: | Free text / diagram / whiteboard picture / etc. that clearly shows your approach and considerations to build the task list. Existing code patterns in production code base that you will base your work off of. - - type: input + - type: markdown id: tasks attributes: label: Task List description: Bulleted list describing the exit criteria, desired end state and any documentation, monitors, work for DRI, etc. that will need to be added to make sure someone else can support once it's live. placeholder: \[\] Tasks go here - - type: input + - type: textarea id: date attributes: label: Estimated Completion Date - - type: input + - type: markdown id: review attributes: description: 1-2 people needed for signoff From 21aed12759aed250e166f33f40c0178692a589b9 Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Wed, 11 Sep 2024 13:20:13 -0500 Subject: [PATCH 04/11] docs: fixes and review --- .github/ISSUE_TEMPLATE/bug.yml | 6 ++--- .github/ISSUE_TEMPLATE/feature.yml | 8 +++--- .github/ISSUE_TEMPLATE/work-item.yml | 38 +++++++++++++++------------- 3 files changed, 27 insertions(+), 25 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 9260483fd0..89b3c5103f 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -34,14 +34,14 @@ body: - Linux - type: textarea attributes: - label: Ape config file + 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: Reproduce the bug - description: Please include a simple reproduction snippet. + label: Reproduction code + description: Please include a simple reproduction code-snippet. validations: required: true diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index c8443198c4..0b6a8b6cc1 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -7,10 +7,10 @@ body: id: describe attributes: label: Describe - description: "Provide a simple overview of what you wish to see added. Please include:" + description: "Provide a simple overview of what you wish to see added." placeholder: | - - What you are trying to do - - Why Ape's current functionality is inadequate to address your goal + I am trying to ... + Ape's current functionality is inadequate because ... validations: required: false - type: textarea @@ -18,7 +18,7 @@ body: attributes: label: Specification description: | - Describe the syntax and semantics of how you would like to see this feature implemented. The more detailed the better!" + 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 diff --git a/.github/ISSUE_TEMPLATE/work-item.yml b/.github/ISSUE_TEMPLATE/work-item.yml index 7a8aa1cbdb..ec271460d6 100644 --- a/.github/ISSUE_TEMPLATE/work-item.yml +++ b/.github/ISSUE_TEMPLATE/work-item.yml @@ -2,15 +2,13 @@ name: Work Item description: New work item for Ape team body: - type: textarea - id: pitch attributes: label: Evelator Pitch - placeholder: 1-2 line summary of the scope of this work item - - type: input - id: value + description: 1-2 line summary of the scope of this work item + - type: textarea attributes: label: Value - placeholder: | + description: | Who is this for? Persona or group of people whom will derive value from the scenario. What benefits will be achieved or business metrics improved? @@ -18,34 +16,38 @@ body: id: dependencies attributes: label: Dependencies - placeholder: | + description: | Call out key people, teams, tech dependencies, or assumptions. - type: textarea - id: approach attributes: label: Design Approach - placeholder: | + description: | Free text / diagram / whiteboard picture / etc. that clearly shows your approach and considerations to build the task list. Existing code patterns in production code base that you will base your work off of. - type: markdown - id: tasks attributes: - label: Task List - description: Bulleted list describing the exit criteria, desired end state and any documentation, monitors, work for DRI, etc. that will need to be added to make sure someone else can support once it's live. - placeholder: \[\] Tasks go here - - type: textarea + value: | + ### Task List + + Bulleted list describing the exit criteria, desired end state and any documentation, monitors, work for DRI, etc. that will need to be added to make sure someone else can support once it's live. + + [ ] Tasks go here + + - type: input id: date attributes: label: Estimated Completion Date - type: markdown - id: review attributes: - description: 1-2 people needed for signoff - label: | + value: | + ### Sign-off + + 1-2 people needed for signoff + 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. + 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) From fa48fcc793403434f923c234aafb288c89935524 Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Mon, 16 Sep 2024 14:28:15 -0500 Subject: [PATCH 05/11] fix: some pr feedback --- .github/ISSUE_TEMPLATE/bug.yml | 1 + .github/ISSUE_TEMPLATE/work-item.yml | 53 ---------------------------- 2 files changed, 1 insertion(+), 53 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/work-item.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 89b3c5103f..2286545450 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -32,6 +32,7 @@ body: - macOS (Intel) - macOS (Apple Silicon) - Linux + required: true - type: textarea attributes: label: ape-config.yaml file diff --git a/.github/ISSUE_TEMPLATE/work-item.yml b/.github/ISSUE_TEMPLATE/work-item.yml deleted file mode 100644 index ec271460d6..0000000000 --- a/.github/ISSUE_TEMPLATE/work-item.yml +++ /dev/null @@ -1,53 +0,0 @@ -name: Work Item -description: New work item for Ape team -body: - - type: textarea - attributes: - label: Evelator Pitch - description: 1-2 line summary of the scope of this work item - - type: textarea - attributes: - label: Value - description: | - Who is this for? - Persona or group of people whom will derive value from the scenario. - What benefits will be achieved or business metrics improved? - - type: textarea - id: dependencies - attributes: - label: Dependencies - description: | - Call out key people, teams, tech dependencies, or assumptions. - - type: textarea - attributes: - label: Design Approach - description: | - Free text / diagram / whiteboard picture / etc. that clearly shows your approach and considerations to build the task list. - Existing code patterns in production code base that you will base your work off of. - - type: markdown - attributes: - value: | - ### Task List - - Bulleted list describing the exit criteria, desired end state and any documentation, monitors, work for DRI, etc. that will need to be added to make sure someone else can support once it's live. - - [ ] Tasks go here - - - type: input - id: date - attributes: - label: Estimated Completion Date - - type: markdown - attributes: - value: | - ### Sign-off - - 1-2 people needed for signoff - - 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) From 238990630885526db3994e06d85014f7e4f1efe0 Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Mon, 16 Sep 2024 14:29:13 -0500 Subject: [PATCH 06/11] fix: undo --- .github/ISSUE_TEMPLATE/bug.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 2286545450..89b3c5103f 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -32,7 +32,6 @@ body: - macOS (Intel) - macOS (Apple Silicon) - Linux - required: true - type: textarea attributes: label: ape-config.yaml file From d8479756a8da4a1c970a315563d00139fef73176 Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Mon, 16 Sep 2024 14:30:13 -0500 Subject: [PATCH 07/11] fix: try this way --- .github/ISSUE_TEMPLATE/bug.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 89b3c5103f..ce0c37d2d0 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -32,6 +32,8 @@ body: - macOS (Intel) - macOS (Apple Silicon) - Linux + validations: + required: true - type: textarea attributes: label: ape-config.yaml file From ac2623c5020143c2240c1c6724a8137d7aae7aba Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Mon, 16 Sep 2024 14:31:06 -0500 Subject: [PATCH 08/11] fix: deindent --- .github/ISSUE_TEMPLATE/bug.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index ce0c37d2d0..9768b43c78 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -32,8 +32,8 @@ body: - macOS (Intel) - macOS (Apple Silicon) - Linux - validations: - required: true + validations: + required: true - type: textarea attributes: label: ape-config.yaml file From 34cff148dcc731d35d4e1e954bc9ea55ddbd2de1 Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Mon, 16 Sep 2024 14:51:13 -0500 Subject: [PATCH 09/11] chore: delete files unchanged from gh repo --- .github/FUNDING.yml | 1 - .github/PULL_REQUEST_TEMPLATE.md | 23 ------------- CONTRIBUTING.md | 55 ++++---------------------------- 3 files changed, 7 insertions(+), 72 deletions(-) delete mode 100644 .github/FUNDING.yml delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md 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/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/CONTRIBUTING.md b/CONTRIBUTING.md index 9d6d9c7f32..8e86220324 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,27 +1,23 @@ # Development -To get started with working on the codebase, use the following steps to prepare your local environment: +To get started with working on the codebase, use the following steps prepare your local environment: ```bash -# clone the GitHub repo and navigate into the folder -git clone https://github.com/ApeWorX/ape.git -cd ape +# clone the github repo and navigate into the folder +git clone https://github.com/ApeWorX/.git +cd # create and load a virtual environment python3 -m venv venv source venv/bin/activate +# install into the virtual environment +python setup.py install + # install the developer dependencies (-e is interactive mode) pip install -e .'[dev]' ``` -```{note} -You might run into issues where you have a local install and are trying to work with a plugin pinned to a specific version. -``` - -[The easiest solution](https://github.com/ApeWorX/ape/issues/90) to this is to fetch the tags via `git fetch upstream --tags` and reinstall via `pip install .`. -You will then have the correct version. - ## Pre-Commit Hooks We use [`pre-commit`](https://pre-commit.com/) hooks to simplify linting and ensure consistent formatting among contributors. @@ -36,43 +32,6 @@ pre-commit install Committing will now automatically run the local hooks and ensure that your commit passes all lint checks. -## GitHub Access Token - -If you are a member of ApeWorX and would like to install private plugins, -[create a GitHub access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). - -Once you have your token, export it to your terminal session: - -```bash -export GITHUB_ACCESS_TOKEN= -``` - -## Running the docs locally - -First, make sure you have the docs-related tooling installed: - -```bash -pip install -e .'[doc]' -``` - -Then, run the following from the root project directory: - -```bash -python build_docs.py -``` - -For the best viewing experience, use a local server: - -```bash -python -m http.server --directory "docs/_build/" --bind 127.0.0.1 1337 -``` - -Then, open your browser to `127.0.0.1:1337` and click the `ape` directory link. - -```{note} -Serving from `"docs/_build/"` rather than `"docs/_build/ape"` is necessary to make routing work. -``` - ## Pull Requests Pull requests are welcomed! Please adhere to the following: From 2f5f9e41366765a3d05d33f8f82ac1b226ff501f Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Mon, 16 Sep 2024 14:53:44 -0500 Subject: [PATCH 10/11] fix: undo contrib changes oops --- CONTRIBUTING.md | 55 ++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 48 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e86220324..9d6d9c7f32 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,23 +1,27 @@ # Development -To get started with working on the codebase, use the following steps prepare your local environment: +To get started with working on the codebase, use the following steps to prepare your local environment: ```bash -# clone the github repo and navigate into the folder -git clone https://github.com/ApeWorX/.git -cd +# clone the GitHub repo and navigate into the folder +git clone https://github.com/ApeWorX/ape.git +cd ape # create and load a virtual environment python3 -m venv venv source venv/bin/activate -# install into the virtual environment -python setup.py install - # install the developer dependencies (-e is interactive mode) pip install -e .'[dev]' ``` +```{note} +You might run into issues where you have a local install and are trying to work with a plugin pinned to a specific version. +``` + +[The easiest solution](https://github.com/ApeWorX/ape/issues/90) to this is to fetch the tags via `git fetch upstream --tags` and reinstall via `pip install .`. +You will then have the correct version. + ## Pre-Commit Hooks We use [`pre-commit`](https://pre-commit.com/) hooks to simplify linting and ensure consistent formatting among contributors. @@ -32,6 +36,43 @@ pre-commit install Committing will now automatically run the local hooks and ensure that your commit passes all lint checks. +## GitHub Access Token + +If you are a member of ApeWorX and would like to install private plugins, +[create a GitHub access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). + +Once you have your token, export it to your terminal session: + +```bash +export GITHUB_ACCESS_TOKEN= +``` + +## Running the docs locally + +First, make sure you have the docs-related tooling installed: + +```bash +pip install -e .'[doc]' +``` + +Then, run the following from the root project directory: + +```bash +python build_docs.py +``` + +For the best viewing experience, use a local server: + +```bash +python -m http.server --directory "docs/_build/" --bind 127.0.0.1 1337 +``` + +Then, open your browser to `127.0.0.1:1337` and click the `ape` directory link. + +```{note} +Serving from `"docs/_build/"` rather than `"docs/_build/ape"` is necessary to make routing work. +``` + ## Pull Requests Pull requests are welcomed! Please adhere to the following: From 164e9515cd989ec5f442395ac1b1519484780ea7 Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Mon, 16 Sep 2024 14:55:38 -0500 Subject: [PATCH 11/11] chore: del security guide --- SECURITY.md | 64 ----------------------------------------------------- 1 file changed, 64 deletions(-) delete mode 100644 SECURITY.md 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).