Skip to content

Commit

Permalink
Merge branch 'main' into feat/off-ramp
Browse files Browse the repository at this point in the history
  • Loading branch information
wachunei committed Sep 25, 2023
2 parents caec87e + 481412d commit afdec53
Show file tree
Hide file tree
Showing 299 changed files with 18,099 additions and 5,653 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ If you're picking up a bounty or an existing issue, feel free to ask clarifying
### Submitting a pull request
When you're done with your project / bugfix / feature and ready to submit a PR, there are a couple guidelines we ask you to follow:

- [ ] **Make sure you followed our [`coding guidelines`](https://github.com/MetaMask/metamask-mobile/blob/main/.github/coding_guidelines/CODING_GUIDELINES.md)**: These guidelines aim to maintain consistency and readability across the codebase. They help ensure that the code is easy to understand, maintain, and modify, which is particularly important when working with multiple contributors.
- [ ] **Make sure you followed our [`coding guidelines`](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md)**: These guidelines aim to maintain consistency and readability across the codebase. They help ensure that the code is easy to understand, maintain, and modify, which is particularly important when working with multiple contributors.
- [ ] **Test it**: For any new programmatic functionality, we like unit tests when possible, so if you can keep your code cleanly isolated, please do add a test file to the `tests` folder.
- [ ] **Add to the CHANGELOG**: Help us keep track of all the moving pieces by adding an entry to the [`CHANGELOG.md`](https://github.com/MetaMask/metamask-mobile/blob/main/CHANGELOG.md) with a link to your PR.
- [ ] **Meet the spec**: Make sure the PR adds functionality that matches the issue you're closing. This is especially important for bounties: sometimes design or implementation details are included in the conversation, so read carefully!
- [ ] **Close the issue**: If this PR closes an open issue, add the line `fixes #$ISSUE_NUMBER`. Ex. For closing issue 418, include the line `fixes #418`. If it doesn't close the issue but addresses it partially, just include a reference to the issue number, like `#418`.
- [ ] **Keep it simple**: Try not to include multiple features in a single PR, and don't make extraneous changes outside the scope of your contribution. All those touched files make things harder to review ;)
- [ ] **PR against `main`**: Submit your PR against the `main` branch. This is where we merge new features to be included in forthcoming releases. When we initiate a new release, we create a branch named `release/x.y.z`, serving as a snapshot of the `main` branch. This particular branch is utilized to construct the builds, which are then tested during the release regression testing phase before they are submitted to the stores for production. In the event your PR is a hot-fix for a bug identified on the `release/x.y.z` branch, you should still submit your PR against the `main` branch. This PR will subsequently be cherry-picked into the `release/x.y.z` branch by our release engineers.
- [ ] **Get the PR reviewed by code owners**: At least two code owner approvals are mandatory before merging any PR.
- [ ] **Ensure the PR is correctly labeled.**: More detail about labels definitions can be found [here](https://github.com/MetaMask/metamask-mobile/blob/main/.github/coding_guidelines/LABELING_GUIDELINES.md).
- [ ] **Ensure the PR is correctly labeled.**: More detail about labels definitions can be found [here](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md).

And that's it! Thanks for helping out.
103 changes: 103 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
name: Bug Report
description: Using MetaMask, but it's not working as you expect?
title: "[Bug]: "
labels: ["type-bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
## **Before Submitting:**
* Please search to make sure this issue has not been opened already.
* If this is a question about how to integrate MetaMask with your project, please ask in our [Community forum](https://community.metamask.io/c/developer-questions/) instead. This will get your question answered more quickly and make it easier for other devs to find the answer in the future.
- type: textarea
id: what-happened
attributes:
label: Describe the bug
description: What happened?
placeholder: A clear and concise description of what the bug is
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What did you expect to happen?
- type: textarea
id: screenshot
attributes:
label: Screenshots
description: Please include screenshots if applicable!
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
description: "List all steps needed to reproduce the problem:"
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: textarea
id: error
attributes:
label: Error messages or log output
description: Please copy and paste any relevant error messages or log output. This will be automatically formatted, so there is no need for backticks.
render: shell
- type: input
id: version
attributes:
label: Version
description: What version of MetaMask are you running? You can find the version in "Settings" > "About"
validations:
required: true
- type: dropdown
id: build
attributes:
label: Build type
description: Are you using a testing or development build of MetaMask? If so, please select the type of build you are using.
options:
- Beta
- Flask
- Other (please specify exactly where you obtained this build in "Additional Context" section)
- type: input
id: devices
attributes:
label: Device
description: Which device have you seen the problem on?
placeholder: |
Brand and model of your device
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating system
description: Which operating systems have you seen the problem on?
multiple: true
options:
- iOS
- Android
- Other (please elaborate in the "Additional Context" section)
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here, e.g. related issues, additional error messages or logs, or any potentially relevant details about the environment or situation the bug occurred in.
- type: textarea
id: severity
attributes:
label: Severity
description: |
To be added after bug submission by internal support / PM:
placeholder: |
- How critical is the impact of this bug on a user?
- Add stats if available on % of customers impacted
- Is this visible to all users?
- Is this tech debt?
40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

50 changes: 0 additions & 50 deletions .github/ISSUE_TEMPLATE/componentization.md

This file was deleted.

8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Request a new feature
url: https://community.metamask.io/c/feature-requests-ideas/
about: Request new features and vote on the ones that are important to you
- name: Get support or ask a question
url: https://metamask.zendesk.com/hc/en-us
about: Use the MetaMask support system to get help and ask questions
105 changes: 105 additions & 0 deletions .github/ISSUE_TEMPLATE/general-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
name: General issue
description: For any issues
labels: []
assignees: []

body:
- type: markdown
attributes:
value: |
## **Description**
- type: textarea
id: description
attributes:
label: What is this about?
placeholder: Describe the issue here.
validations:
required: true

- type: markdown
attributes:
value: |
## **Scenario (for user stories only)**
- type: textarea
id: scenario
attributes:
label: Scenario
placeholder: |
- GIVEN a user is in x state
- WHEN a user does x
- AND a user does x
- THEN x should occur
- type: markdown
attributes:
value: |
## **Design (for user stories only)**
- type: textarea
id: design
attributes:
label: Design
placeholder: If available, provide a link to the design (e.g., Figma) or screenshots. If you're an external contributor and don't have access to the design, feel free to skip this step or provide any visual representation of the issue if possible.

- type: markdown
attributes:
value: |
## **Technical Details (for technical tasks only)**
- type: textarea
id: technical-details
attributes:
label: Technical Details
placeholder: |
- Implementation details
- Insight to what needs to be done
- Etc.
- type: markdown
attributes:
value: |
## **[Threat Modeling Framework](https://github.com/adamshostack/4QuestionFrame) (for technical tasks only)**
- type: textarea
id: threat-modeling
attributes:
label: Threat Modeling Framework
placeholder: |
- What are we working on? What does this aim to solve?
- What can go wrong?
- What are we going to do about it?
- Did we do a good job?
- type: markdown
attributes:
value: |
## **Acceptance Criteria**
- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
placeholder: |
- Are metrics required?
- Are translations required?
- Cases to satisfy
- XYZ should work
- Etc.
- type: markdown
attributes:
value: |
## **References**
- type: textarea
id: references
attributes:
label: References
placeholder: |
- References go here.
- Screenshots.
- Issue numbers. Links.
- Slack threads.
- Etc.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/general_issue.md

This file was deleted.

23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/usability-enhancement.md

This file was deleted.

Loading

0 comments on commit afdec53

Please sign in to comment.