From 612b08065d0db530bafcb4d1e11fcc2cda3fd7a0 Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Tue, 11 Jun 2024 11:26:11 +0100 Subject: [PATCH 01/10] edits: changes to files in repo --- CODE_OF_CONDUCT.md | 105 +++++++++++++++++++++++---------------------- 1 file changed, 53 insertions(+), 52 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 4b7de78dd6..7b053d4f22 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,76 +1,77 @@ -# Contributor Covenant Code of Conduct +# Code of Conduct ## Our Pledge -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards -Examples of behavior that contributes to creating a positive environment -include: +Examples of behavior that contributes to a positive environment for our community include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall community -Examples of unacceptable behavior by participants include: +Examples of unacceptable behavior include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting +- The use of sexualized language or imagery, and sexual attention or advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting -## Our Responsibilities +## Enforcement Responsibilities -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. +Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at developer@fetch.ai. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at _developer@fetch.ai_. All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of actions. + +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. +**Consequence**: A permanent ban from any sort of public interaction within the community. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at +This Code of Conduct is adapted from the , version 2.1, available at . -[homepage]: https://www.contributor-covenant.org +Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity). -For answers to common questions about this code of conduct, see - +For answers to common questions about this code of conduct, see the FAQ at: . Translations are available at . From ea24427599147182af0eced95ad0dabab9078bd6 Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Tue, 11 Jun 2024 11:51:34 +0100 Subject: [PATCH 02/10] edits: added content --- .github/pull_request_template.md | 0 .../workflows/ISSUE_TEMPLATE/bug-report.yml | 82 +++++++++ .github/workflows/ISSUE_TEMPLATE/config.yml | 1 + .../ISSUE_TEMPLATE/feature-request.yml | 34 ++++ .../PULL_REQUEST_TEMPLATE/release.md | 20 +++ CONTRIBUTING.md | 156 ++++++++++++++++++ DEVELOPING.md | 65 ++++++++ SECURITY.md | 28 ++-- 8 files changed, 374 insertions(+), 12 deletions(-) create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/workflows/ISSUE_TEMPLATE/config.yml create mode 100644 .github/workflows/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/workflows/PULL_REQUEST_TEMPLATE/release.md create mode 100644 CONTRIBUTING.md create mode 100644 DEVELOPING.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/.github/workflows/ISSUE_TEMPLATE/bug-report.yml b/.github/workflows/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..45ee6bc094 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,82 @@ +name: 🐛 Bug Report +description: Report a bug for Fetch Wallet. +labels: ["bug", "unconfirmed"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! We appreciate your contribution to improving the project. + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + description: Please confirm before submitting any new bug report. + options: + - label: I checked the [documentation](https://fetch.ai/docs) and found no answer to my problem + required: true + - label: I checked the [existing issues](https://github.com/fetchai/fetch-wallet/issues) and made sure there are no similar bug reports + required: true + - type: dropdown + id: category + attributes: + label: Category + description: Select the category that best describes the bug. + options: + - Bug (unexpected behavior) + - Documentation Issue (error or unclear information in docs) + - Other + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: Describe the behavior you are expecting. + validations: + required: false + - type: textarea + id: actual + attributes: + label: Observed Behavior + description: Describe the behavior you are observing. + validations: + required: true + - type: textarea + id: steps + attributes: + label: To Reproduce + description: Provide steps to reproduce the issue. + validations: + required: false + - type: input + id: version + attributes: + label: uAgents Version + description: Which version of the library were you using? Please enter the version number here. + placeholder: ex. v0.5.0 + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment Details (Optional) + description: Provide any relevant information about your environment, such as operating system, Python version, and any other libraries used. + render: markdown + validations: + required: false + - type: textarea + id: logs + attributes: + label: Failure Logs (Optional) + description: Include any relevant log snippets or files here. You can paste directly or drag and drop files into this area. + render: shell + validations: + required: false + - type: textarea + id: additional + attributes: + label: Additional Information (Optional) + description: Include any screenshots, code snippets, or other relevant details that might help us understand the bug. + render: markdown + validations: + required: false diff --git a/.github/workflows/ISSUE_TEMPLATE/config.yml b/.github/workflows/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..3ba13e0cec --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/workflows/ISSUE_TEMPLATE/feature-request.yml b/.github/workflows/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..45de1cc6a1 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,34 @@ +name: ☝️Feature request +description: Suggest an idea for the Fetch Wallet. +labels: ["enhancement", "unconfirmed"] +body: + - type: markdown + attributes: + value: | + Thank you for suggesting a new idea! Please complete the following so we have everything to get started. + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + description: Please confirm before submitting a feature request. + options: + - label: I checked the [documentation](https://fetch.ai/docs) and made sure this feature does not already exist + required: true + - label: I checked the [existing issues](https://github.com/fetchai/fetch-wallet/issues) to make sure this feature has not already been requested + required: true + - type: textarea + id: feature + attributes: + label: Feature + description: | + Provide a description of the feature you would like to see implemented within the Fetch Wallet. + validations: + required: true + - type: textarea + id: info + attributes: + label: Additional Information (Optional) + description: | + Add any other context, screenshots, or information that could be helpful for understanding your feature request. + validations: + required: false diff --git a/.github/workflows/PULL_REQUEST_TEMPLATE/release.md b/.github/workflows/PULL_REQUEST_TEMPLATE/release.md new file mode 100644 index 0000000000..14385ee5f0 --- /dev/null +++ b/.github/workflows/PULL_REQUEST_TEMPLATE/release.md @@ -0,0 +1,20 @@ +## Version Number + +_[version number (e.g. v1.0.1)]_ + +## Release Details + +_[briefly describe the main changes with this release]_ + +## Checklist + +_Put an `x` in the boxes that apply._ + +- [ ] I am making a pull request against the `master` branch +- [ ] Checks and tests pass locally +- [ ] I have regenerated and updated the API docs +- [ ] The documentation is up-to-date + +## Further Comments + +_[any other comments about this release]_ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..52d04bb924 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,156 @@ +# Contribution Guidelines + +Contributions to the **Fetch Wallet** are welcome. As a contributor, here are the guidelines we would like you to follow: + +- [Code of Conduct](#coc) +- [Question or Problem?](#question) +- [Issues and Bugs](#issue) +- [Feature Requests](#feature) +- [Submission Guidelines](#submit) +- [Coding Rules](#rules) +- [Commit Message Guidelines](#commit) +- [Merge Pull Requests](#merge) + +## Code of Conduct + + +Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). + + +## Question or Problem? + + +Please use [GitHub Discussions](https://github.com/fetchai/fetch-wallet/discussions) for support related questions and general discussions. Do NOT open issues as they are for bug reports and feature requests. This is because: + + +- Questions and answers stay available for public viewing so your question/answer might help someone else. +- GitHub Discussions voting system ensures the best answers are prominently visible. + +## Found a Bug? + +If you find a bug in the source code [submit a bug report issue](#submit-issue). +Even better, you can [submit a Pull Request](#submit-pr) with a fix. + +## Missing a Feature? + +You can *request* a new feature by [submitting a feature request issue](#submit-issue). +If you would like to *implement* a new feature: + +- For a **Major Feature**, first [open an issue](#submit-issue) and outline your proposal so that it can be discussed. +- **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). + +## Submission Guidelines + +### Submitting an Issue + + +Before you submit an issue, please search the [issue tracker](https://github.com/fetchai/fetch-wallet/issues). An issue for your problem might already exist and the discussion might inform you of workarounds readily available. + +For bug reports, it is important that we can reproduce and confirm it. For this, we need you to provide a minimal reproduction instruction (this is part of the bug report issue template). + +You can file new issues by selecting from our [new issue templates](https://github.com/fetchai/fetch-wallet/issues/new/choose) and filling out the issue template. + + +### Submitting a Pull Request (PR) + +Before you submit your Pull Request (PR) consider the following guidelines: + +1. All Pull Requests should be based off of and opened against the `master` branch. + + +2. Search [Existing PRs](https://github.com/fetchai/fetch-wallet/pulls) for an open or closed PR that relates to your submission. + You don't want to duplicate existing efforts. + + +3. Be sure that an issue exists describing the problem you're fixing, or the design for the feature you'd like to add. + + +4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the [repository](https://github.com/fetchai/fetch-wallet). + + +5. In your forked repository, make your changes in a new git branch created off of the `master` branch. + +6. Make your changes, **including test cases and documentation updates where appropriate**. + +7. Follow our [coding rules](#rules). + + +8. Run all tests and checks locally, as described in the [development guide](CONTRIBUTING.md), and ensure they pass. This saves CI hours and ensures you only commit clean code. + + +9. Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). + +10. Push your branch to GitHub. + +11. In GitHub, send a pull request to `fetchai:master`. + +#### Reviewing a Pull Request + + +The μAgents team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following our [code of conduct](CODE_OF_CONDUCT.md) and applies within or outside the managed channels. + + +When you contribute a new feature, the maintenance burden is transferred to the core team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature. + +#### Addressing review feedback + +If we ask for changes via code reviews then: + +1. Make the required updates to the code. + +2. Re-run the tests and checks to ensure they are still passing. + +3. Create a new commit and push to your GitHub repository (this will update your Pull Request). + +#### After your pull request is merged + +After your pull request is merged, you can safely delete your branch and pull the changes from the (upstream) repository. + +## Coding Rules + +To ensure consistency throughout the source code, keep these rules in mind as you are working: + + +- All code must pass our code quality checks (linters, formatters, etc). See the [development guide](CONTRIBUTING.md) section for more detail. + + +- All features **must be tested** via unit-tests and if applicable integration-tests. Bug fixes also require tests, because the presence of bugs usually indicates insufficient test coverage. Tests help to: + + 1. Prove that your code works correctly, and + 2. Guard against future breaking changes and lower the maintenance cost. + +- All public features **must be documented**. +- All files must include a license header. +- Keep API compatibility in mind when you change any code under `fetch-wallet`. Above version `1.0.0`, breaking changes can happen across versions with different left digit. Below version `1.0.0`, they can happen across versions with different middle digit. Reviewers of your pull request will comment on any API compatibility issues. + +## Commit Message Convention + +This project uses Conventional Commits to generate release notes and to determine versioning. Please follow the [Conventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). The commit types must be one of the following: + + - **chore**: Commits that don't directly add features, fix bugs, or refactor code, but rather maintain the project or its surrounding processes. + - **ci**: Changes to our CI configuration files and scripts + - **docs**: Changes to the documentation + - **feat**: A new feature + - **fix**: A bug fix + - **refactor**: A code change that neither fixes a bug nor adds a feature + - **test**: Adding missing tests or correcting existing tests + - **revert**: Reverts a previous commit that introduced an issue or unintended change. This essentially undoes a previous commit. + - **style**: Changes that only affect code formatting or style, without affecting functionality. This ensures consistency and readability of the codebase. + - **perf**: Changes that improve the performance of the project. + +Commit messages should adhere to this standard and be of the form: + + ```bash + git commit -m "feat: add new feature x" + git commit -m "fix: fix bug in feature x" + git commit -m "docs: add documentation for feature x" + git commit -m "test: add test suite for feature x" + ``` + +Further details on `conventional commits` can be found [here](https://www.conventionalcommits.org/en/v1.0.0/). + +## Merging Pull Requests + +When merging a branch, PRs should be squashed into one conventional commit by selecting the `Squash and merge` option. This ensures Release notes are useful and readable when releases are created. + +See [Merge strategies](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) from the official GitHub documentation. diff --git a/DEVELOPING.md b/DEVELOPING.md new file mode 100644 index 0000000000..8b3a127d3c --- /dev/null +++ b/DEVELOPING.md @@ -0,0 +1,65 @@ +# Development Guidelines + +- [Getting the Source](#get) +- [Setting up a New Development Environment](#setup) +- [Development](#dev) +- [Tests](#tests) +- [Contributing](#contributing) + +## Getting the Source + + +1. Fork the [repository](https://github.com/fetchai/fetch-wallet.git). +2. Clone your fork of the repository: + + + ``` shell + git clone https://github.com/fetchai/fetch-wallet.git + ``` + +3. Define an `upstream` remote pointing back to the main uAgents repository: + + ``` shell + git remote add upstream https://github.com/fetchai/fetch-wallet.git + ``` + +## Setting up a New Development Environment + +## Development setup + +The easiest way to get set up for development is to install Python (`3.9` to `3.12`) and [poetry](https://pypi.org/project/poetry/), and then run the following from the top-level project directory: + +```bash + cd python + poetry install + poetry shell + pre-commit install +``` + +## Development + + +When developing for `fetch-wallet` make sure to have the poetry shell active. This ensures that linting and formatting will automatically be checked during `git commit`. + +We are using [Ruff](https://github.com/astral-sh/ruff) with added rules for formatting and linting. +Please consider adding `ruff` to your IDE to speed up the development process and ensure you only commit clean code. + +Alternately you can invoke ruff by typing the following from within the `./python` folder + +```bash + ruff check --fix && ruff format +``` + +### Tests + +To run tests use the following command: + +```bash + pytest +``` + +## Contributing + + +For instructions on how to contribute to the project (e.g. creating Pull Requests, commit message convention, etc), see the [contributing guide](CONTRIBUTING.md). + diff --git a/SECURITY.md b/SECURITY.md index 07aefb01ba..91fd99ac1d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,16 +1,22 @@ # Security Policy -This document outlines security procedures and general policies for the `Fetch Wallet` project. +Security is very important for Fetch.ai and its community. This document outlines security procedures and general policies for the `fetch-wallet`. -## Reporting a Vulnerability +## How to Report -The `Fetch Wallet` team and community take all security bugs in `Fetch Wallet` seriously. We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions. +Please follow the steps listed below to report your bug: -Report security bugs by emailing `developer@fetch.ai`. +- In an email, describe the issue clearly with reference to the underlying source code and indicate whether the bug is **Critical** or **Non-critical**. +- Attach all relevant information that is required to reproduce the bug in a test environment. +- Include the relevant version information associated with the faulty software of the components along with any other relevant system information such as OS versions. +- Include suggested solutions and/or mitigations (if known). +- Send this email to [security@fetch.ai](mailto:security@fetch.ai) and start the subject with your classification **Critical** or **Non-critical** followed by a short title of the bug. -The lead maintainer will acknowledge your email within 48 hours, and will send a more detailed response within 48 hours indicating the next steps in handling your report. After the initial reply to your report, the security team will endeavour to keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance. +The Fetch team will review your information and your classification of the bug. -Report security bugs in third-party modules to the person or team maintaining the module. +For non-critical bugs, the Fetch team will create an issue or a pull request allowing you to follow the progress on the bug fix. + +For critical bugs that can result in loss of funds, it is important that the Fetch team has an opportunity to deploy a patched version before the exploit is acknowledged publicly. Hence, critical bugs and their fixes will be shared after the code is patched to prevent the targeting of such exploits. ## Disclosure Policy @@ -24,14 +30,12 @@ When the security team receives a security bug report, they will assign it to a If you have suggestions on how this process could be improved please submit a pull request. -## Bug Bounty - -We have a [**bug bounty program**](https://docs.fetch.ai/bug_bounty/). Please report any security issues you find, or reach out to `developer@fetch.ai`. Please try to be as explicit as possible, describing all the steps and example code to reproduce the security issue. - -Critical bug fixes will be backported to past major releases. - ## Public Discussions Please restrain from publicly discussing a potential security vulnerability. 🙊 It's better to discuss privately and try to find a solution first, to limit the potential impact as much as possible. + +--- + +Thanks for your help! \ No newline at end of file From 03ee17f98567edc4f6b46f502c99e2986f8c6c1c Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Wed, 19 Jun 2024 09:16:12 +0100 Subject: [PATCH 03/10] edits --- CITATION.cff | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index 2f1892cee0..8773a5175d 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -3,6 +3,6 @@ message: "If you use Fetch Wallet in your research or project, please cite it as title: μAgents Library authors: - family-names: Fetch.ai -date-released: "2022-09-28" +date-released: "2019-08-28" url: "https://github.com/fetchai/fetch-wallet" license: "Apache-2.0" From 87ea4f4dd70c33005f56b19e903887aff37b4022 Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:00:06 +0100 Subject: [PATCH 04/10] Delete CITATION.cff --- CITATION.cff | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff deleted file mode 100644 index 8773a5175d..0000000000 --- a/CITATION.cff +++ /dev/null @@ -1,8 +0,0 @@ -cff-version: 1.2.0 -message: "If you use Fetch Wallet in your research or project, please cite it as follows:" -title: μAgents Library -authors: - - family-names: Fetch.ai -date-released: "2019-08-28" -url: "https://github.com/fetchai/fetch-wallet" -license: "Apache-2.0" From b889b08315e1d52cf288427385bd8bffb315ea1c Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:01:01 +0100 Subject: [PATCH 05/10] Delete DEVELOPING.md --- DEVELOPING.md | 65 --------------------------------------------------- 1 file changed, 65 deletions(-) delete mode 100644 DEVELOPING.md diff --git a/DEVELOPING.md b/DEVELOPING.md deleted file mode 100644 index 8b3a127d3c..0000000000 --- a/DEVELOPING.md +++ /dev/null @@ -1,65 +0,0 @@ -# Development Guidelines - -- [Getting the Source](#get) -- [Setting up a New Development Environment](#setup) -- [Development](#dev) -- [Tests](#tests) -- [Contributing](#contributing) - -## Getting the Source - - -1. Fork the [repository](https://github.com/fetchai/fetch-wallet.git). -2. Clone your fork of the repository: - - - ``` shell - git clone https://github.com/fetchai/fetch-wallet.git - ``` - -3. Define an `upstream` remote pointing back to the main uAgents repository: - - ``` shell - git remote add upstream https://github.com/fetchai/fetch-wallet.git - ``` - -## Setting up a New Development Environment - -## Development setup - -The easiest way to get set up for development is to install Python (`3.9` to `3.12`) and [poetry](https://pypi.org/project/poetry/), and then run the following from the top-level project directory: - -```bash - cd python - poetry install - poetry shell - pre-commit install -``` - -## Development - - -When developing for `fetch-wallet` make sure to have the poetry shell active. This ensures that linting and formatting will automatically be checked during `git commit`. - -We are using [Ruff](https://github.com/astral-sh/ruff) with added rules for formatting and linting. -Please consider adding `ruff` to your IDE to speed up the development process and ensure you only commit clean code. - -Alternately you can invoke ruff by typing the following from within the `./python` folder - -```bash - ruff check --fix && ruff format -``` - -### Tests - -To run tests use the following command: - -```bash - pytest -``` - -## Contributing - - -For instructions on how to contribute to the project (e.g. creating Pull Requests, commit message convention, etc), see the [contributing guide](CONTRIBUTING.md). - From 4ebccbd66fe697d956cb402200a9d5eef2c62a75 Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:02:38 +0100 Subject: [PATCH 06/10] Apply suggestions from code review --- .github/workflows/ISSUE_TEMPLATE/bug-report.yml | 5 +++-- .github/workflows/ISSUE_TEMPLATE/config.yml | 2 +- .github/workflows/ISSUE_TEMPLATE/feature-request.yml | 2 ++ .github/workflows/PULL_REQUEST_TEMPLATE/release.md | 1 - 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ISSUE_TEMPLATE/bug-report.yml b/.github/workflows/ISSUE_TEMPLATE/bug-report.yml index 7e61ff37ff..95abf08181 100644 --- a/.github/workflows/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/workflows/ISSUE_TEMPLATE/bug-report.yml @@ -1,6 +1,8 @@ name: 🐛 Bug Report description: Report a bug. labels: ["bug", "unconfirmed"] +assignees: + - UrAvgDeveloper body: - type: markdown attributes: @@ -23,7 +25,6 @@ body: description: Select the category that best describes the bug. options: - Bug (unexpected behavior) - - Documentation Issue (error or unclear information in docs) - Other validations: required: true @@ -60,7 +61,7 @@ body: id: environment attributes: label: Environment Details (Optional) - description: Provide any relevant information about your environment, such as operating system, Python version, and any other libraries used. + description: Provide any relevant information about your environment, such as operating system, protoc version, node version and any other libraries used. render: markdown validations: required: false diff --git a/.github/workflows/ISSUE_TEMPLATE/config.yml b/.github/workflows/ISSUE_TEMPLATE/config.yml index 3ba13e0cec..0086358db1 100644 --- a/.github/workflows/ISSUE_TEMPLATE/config.yml +++ b/.github/workflows/ISSUE_TEMPLATE/config.yml @@ -1 +1 @@ -blank_issues_enabled: false +blank_issues_enabled: true diff --git a/.github/workflows/ISSUE_TEMPLATE/feature-request.yml b/.github/workflows/ISSUE_TEMPLATE/feature-request.yml index 9508e61f1e..e500a85e4c 100644 --- a/.github/workflows/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/workflows/ISSUE_TEMPLATE/feature-request.yml @@ -1,6 +1,8 @@ name: ☝️Feature request description: Suggest an idea. labels: ["enhancement", "unconfirmed"] +assignees: + - UrAvgDeveloper body: - type: markdown attributes: diff --git a/.github/workflows/PULL_REQUEST_TEMPLATE/release.md b/.github/workflows/PULL_REQUEST_TEMPLATE/release.md index 016e60a547..e54888e2c0 100644 --- a/.github/workflows/PULL_REQUEST_TEMPLATE/release.md +++ b/.github/workflows/PULL_REQUEST_TEMPLATE/release.md @@ -10,7 +10,6 @@ _[briefly describe the main changes with this release]_ _Put an `x` in the boxes that apply._ -- [ ] I am making a pull request against the `master` branch - [ ] Checks and tests pass locally - [ ] I have updated the version in `pyproject.toml` - [ ] I have regenerated and updated the API docs From 372f1c60fbc92a1700398499e424c9d35cff5c09 Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:28:39 +0100 Subject: [PATCH 07/10] Delete .github/workflows/PULL_REQUEST_TEMPLATE/release.md --- .../PULL_REQUEST_TEMPLATE/release.md | 20 ------------------- 1 file changed, 20 deletions(-) delete mode 100644 .github/workflows/PULL_REQUEST_TEMPLATE/release.md diff --git a/.github/workflows/PULL_REQUEST_TEMPLATE/release.md b/.github/workflows/PULL_REQUEST_TEMPLATE/release.md deleted file mode 100644 index e54888e2c0..0000000000 --- a/.github/workflows/PULL_REQUEST_TEMPLATE/release.md +++ /dev/null @@ -1,20 +0,0 @@ -## Version Number - -_[version number (e.g. v1.0.1)]_ - -## Release Details - -_[briefly describe the main changes with this release]_ - -## Checklist - -_Put an `x` in the boxes that apply._ - -- [ ] Checks and tests pass locally -- [ ] I have updated the version in `pyproject.toml` -- [ ] I have regenerated and updated the API docs -- [ ] The documentation is up-to-date - -## Further Comments - -_[any other comments about this release]_ \ No newline at end of file From adc95f7b34d90e000f55be7b97bc3887d2eae568 Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:36:36 +0100 Subject: [PATCH 08/10] Update .github/pull_request_template.md --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index da26e4bb30..6bd21c4012 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -20,8 +20,10 @@ _What type of change does this pull request make (put an `x` in the boxes that a _Put an `x` in the boxes that apply:_ + - [ ] I have read the [CONTRIBUTING](/CONTRIBUTING.md) guide - [ ] Checks and tests pass locally + ### If applicable From e3b92a73419712b5fca4bd26fad3b572ce3cc8ce Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Thu, 27 Jun 2024 10:21:35 +0100 Subject: [PATCH 09/10] Update .github/workflows/ISSUE_TEMPLATE/bug-report.yml --- .github/workflows/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ISSUE_TEMPLATE/bug-report.yml b/.github/workflows/ISSUE_TEMPLATE/bug-report.yml index 95abf08181..131a725089 100644 --- a/.github/workflows/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/workflows/ISSUE_TEMPLATE/bug-report.yml @@ -61,7 +61,7 @@ body: id: environment attributes: label: Environment Details (Optional) - description: Provide any relevant information about your environment, such as operating system, protoc version, node version and any other libraries used. + description: Provide any relevant information about your environment, such as operating system, bowser and its version, protoc version, node version and anything else that might be useful. render: markdown validations: required: false From 64e45a5f963f7a8578dbb867a34d94e930354c4e Mon Sep 17 00:00:00 2001 From: sh-wallet <137136919+sh-wallet@users.noreply.github.com> Date: Thu, 27 Jun 2024 18:20:07 +0530 Subject: [PATCH 10/10] fix: lint issues --- packages/fetch-extension/src/config.ts | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/packages/fetch-extension/src/config.ts b/packages/fetch-extension/src/config.ts index f2a471fc48..1a9f7586d2 100644 --- a/packages/fetch-extension/src/config.ts +++ b/packages/fetch-extension/src/config.ts @@ -2849,14 +2849,14 @@ export const CommunityChainInfoRepo = { }; export enum TXNTYPE { - ibcTransfer="ibcTransfer", - send="send", - withdrawRewards="withdrawRewards", - delegate="delegate", - undelegate="undelegate", - redelegate="redelegate", - govVote="govVote", - nativeBridgeSend="nativeBridgeSend", - approval="approval", - createSecret20ViewingKey="createSecret20ViewingKey", + ibcTransfer = "ibcTransfer", + send = "send", + withdrawRewards = "withdrawRewards", + delegate = "delegate", + undelegate = "undelegate", + redelegate = "redelegate", + govVote = "govVote", + nativeBridgeSend = "nativeBridgeSend", + approval = "approval", + createSecret20ViewingKey = "createSecret20ViewingKey", }