From d81fc23214269b58bc17da239c9b7404d43d3644 Mon Sep 17 00:00:00 2001 From: Mark Nardi Date: Wed, 8 Nov 2023 12:30:17 +0100 Subject: [PATCH] chore: update old links (#1351) * update old links * update bug report template --- .github/CODE_OF_CONDUCT.md | 20 ++-- .github/CONTRIBUTING.md | 67 +++-------- .github/ISSUE_TEMPLATE/bug_report.yml | 107 ++++++------------ .github/ISSUE_TEMPLATE/config.yml | 7 +- .github/SUPPORT.md | 7 +- README.md | 5 +- .../deep-link/handlers/handleDeepLink.ts | 2 +- .../constants/wallet-metadata.constant.ts | 6 +- .../is-system-in-dark-mode.constant.ts | 2 +- 9 files changed, 69 insertions(+), 154 deletions(-) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index c7672f85e2..d5b0fb0f79 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -1,10 +1,10 @@ # Community Code of Conduct -In the IOTA community, participants from all over the world come together to create. This is made possible by the support, hard work and enthusiasm of thousands of people, including those who create and use the IOTA technology. +In the Bloom community, participants from all over the world come together to create. This is made possible by the support, hard work and enthusiasm of thousands of people, including those who create and use the IOTA technology. -This document offers some guidance to ensure IOTA participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other. +This document offers some guidance to ensure Bloom participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other. -This Code of Conduct is shared by all contributors and users who engage with the IOTA Foundation team and its community services. +This Code of Conduct is shared by all contributors and users who engage with the Bloom Labs team and its community services. ## Overview @@ -17,21 +17,21 @@ This Code of Conduct presents a summary of the shared values and “common sense - Supporting others in the community - Getting support from others in the community -This Code of Conduct reflects the agreed standards of behavior for members of the IOTA community, in any social media platform, forum, mailing list, wiki, web site, discord channel, public meeting or private correspondence within the context of the IOTA Foundation team and the IOTA Tangle technology. The community acts according to the standards written down in this Code of Conduct and will defend these standards for the benefit of the community. Leaders of any group, such as moderators of social media groups, mailing lists, discord channels, forums, etc., will exercise the right to suspend access to any person who persistently breaks our shared Code of Conduct. +This Code of Conduct reflects the agreed standards of behavior for members of the Bloom community, in any social media platform, forum, mailing list, wiki, web site, discord channel, public meeting or private correspondence within the context of the Bloom team. The community acts according to the standards written down in this Code of Conduct and will defend these standards for the benefit of the community. Leaders of any group, such as moderators of social media groups, mailing lists, discord channels, forums, etc., will exercise the right to suspend access to any person who persistently breaks our shared Code of Conduct. ## Be considerate Your actions and work will affect and be used by other people and you, in turn, will depend on the work and actions of others. Any decision you take will affect other community members, and we expect you to take those consequences into account when making decisions. -As a user, remember that community members work hard on their part of IOTA and take great pride in it. +As a user, remember that community members work hard on their part of Bloom and take great pride in it. ## Be respectful -In order for the IOTA community to stay healthy, its members must feel comfortable and accepted. Treating one another with respect is absolutely necessary for this. In a disagreement, in the first instance, assume that people mean well. +In order for the Bloom community to stay healthy, its members must feel comfortable and accepted. Treating one another with respect is absolutely necessary for this. In a disagreement, in the first instance, assume that people mean well. We do not tolerate personal attacks, racism, sexism or any other form of discrimination. Disagreement is inevitable, from time to time, but respect for the views of others will go a long way to winning respect for your own view. Respecting other people, their work, their contributions and assuming well-meaning motivation will make community members feel comfortable and safe and will result in motivation and productivity. -We expect members of our community to be respectful when dealing with other contributors, users, and communities. Remember that IOTA is an international project and that you may be unaware of important aspects of other cultures. +We expect members of our community to be respectful when dealing with other contributors, users, and communities. Remember that Bloom is an international project and that you may be unaware of important aspects of other cultures. ## Be collaborative @@ -39,11 +39,11 @@ Your feedback is important, as is its form. Poorly thought out comments can caus ## Be pragmatic -The IOTA community is pragmatic and fair. We value tangible results over having the last word in a discussion. We defend our core values like freedom and respectful collaboration, but we don’t let arguments about minor issues get in the way of achieving more important results. We are open to suggestions and welcome solutions regardless of their origin. When in doubt support a solution which helps to get things done over one which has theoretical merits, but isn’t being worked on. Use the tools and methods which help to get the job done. Let decisions be taken by those who do the work. +The Bloom community is pragmatic and fair. We value tangible results over having the last word in a discussion. We defend our core values like freedom and respectful collaboration, but we don’t let arguments about minor issues get in the way of achieving more important results. We are open to suggestions and welcome solutions regardless of their origin. When in doubt support a solution which helps to get things done over one which has theoretical merits, but isn’t being worked on. Use the tools and methods which help to get the job done. Let decisions be taken by those who do the work. ## Support others in the community -The IOTA community is made strong by mutual respect, collaboration and pragmatic, responsible behavior. Sometimes there are situations where this has to be defended and other community members need help. +The Bloom community is made strong by mutual respect, collaboration and pragmatic, responsible behavior. Sometimes there are situations where this has to be defended and other community members need help. If you witness others being attacked, think first about how you can offer them personal support. If you feel that the situation is beyond your ability to help individually, go privately to the victim and ask if some form of official intervention is needed. @@ -55,4 +55,4 @@ Disagreements, both political and technical, happen all the time. Our community Think deeply before turning a disagreement into a public dispute. If necessary, request mediation, and try to resolve differences in a less emotional medium. If you do feel that you or your work is being attacked, take your time to think things through before writing heated replies. Consider a 24-hour moratorium if emotional language is being used – a cooling-off period is sometimes all that is needed. If you really want to go a different way, then we encourage you to publish your ideas and your work, so that it can be tried and tested. -This work, "IOTA Community Guidelines", is a derivative of the [Community code of conduct by ownCloud](https://owncloud.org/community/code-of-conduct/), used under [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/). "IOTA Community Guidelines" is licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) by IOTA Foundation. \ No newline at end of file +This work, "Bloom Community Guidelines", is a derivative of the [Community code of conduct by ownCloud](https://owncloud.org/community/code-of-conduct/), used under [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/). "Bloom Community Guidelines" is licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) by Bloom Labs. \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 60deceb15f..c3d21ccff4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -11,10 +11,9 @@ Thanks! :heart: If you have a general or technical question, you can use one of the following resources instead of submitting an issue: -- [**Developer documentation:**](https://docs.iota.org/) For official information about developing with IOTA technology -- [**Discord:**](https://discord.iota.org/) For real-time chats with the developers and community members -- [**IOTA cafe:**](https://iota.cafe/) For technical discussions with the Research and Development Department at the IOTA Foundation -- [**StackExchange:**](https://iota.stackexchange.com/) For technical and troubleshooting questions +- [**IOTA documentation:**](https://wiki.iota.org/) For official information about developing with IOTA technology +- [**Developer documentation:**](https://docs.bloomwallet.io/) For official information about developing with Bloom wallet +- [**Discord:**](https://discord.gg/RjX3jEc7K7) For real-time chats with the developers and community members
@@ -28,7 +27,6 @@ To contribute to wallet on GitHub, you can: - Report a bug - Suggest a new feature - Build a new feature -- Join the wallet Initiative
@@ -43,15 +41,15 @@ This section guides you through reporting a bug. Following these guidelines help Please check the following list: -- **Do not open a GitHub issue for [security vulnerabilities](.github/SECURITY.MD)**, instead, please contact us at [security@iota.org](mailto:security@iota.org). +- **Do not open a GitHub issue for [security vulnerabilities](.github/SECURITY.MD)**, instead, please contact us at [security@bloomwallet.io](mailto:security@bloomwallet.io). -- **Ensure the bug was not already reported** by searching on GitHub under [**Issues**](https://github.com/iotaledger/wallet/issues). If the bug has already been reported **and the issue is still open**, add a comment to the existing issue instead of opening a new one. +- **Ensure the bug was not already reported** by searching on GitHub under [**Issues**](https://github.com/bloomwalletio/bloom/issues). If the bug has already been reported **and the issue is still open**, add a comment to the existing issue instead of opening a new one. **Note:** If you find a **Closed** issue that seems similar to what you're experiencing, open a new issue and include a link to the original issue in the body of your new one. ### Submitting a bug report -To report a bug, [open a new issue](https://github.com/iotaledger/wallet/issues/new), and be sure to include as many details as possible, using the template. +To report a bug, [open a new issue](https://github.com/bloomwalletio/bloom/issues/new?assignees=&labels=bug-report&projects=&template=bug_report.yml&title=%F0%9F%90%9E+-+), and be sure to include as many details as possible, using the template. **Note:** Minor changes such as fixing a typo can but do not need an open issue. @@ -68,13 +66,11 @@ This section guides you through suggesting a new feature. Following these guidel ### Before suggesting a new feature -**Ensure the feature has not already been suggested** by searching on GitHub under [**Issues**](https://github.com/iotaledger/wallet/issues). +**Ensure the feature has not already been suggested** by searching on GitHub under [**Issues**](https://github.com/bloomwalletio/bloom/issues). ### Suggesting a new feature -To suggest a new feature, talk to the IOTA community and IOTA Foundation members in the #wallet-discussion channel on [Discord](https://discord.iota.org/). - -Or, you can submit an official [Request for Comments (RFC)](https://github.com/iotaledger/wallet-rfcs/). +To suggest a new feature, talk to the Bloom team on the [Discord Server](https://discord.gg/RjX3jEc7K7). @@ -88,42 +84,13 @@ This section guides you through building a new feature. Following these guidelin ### Before building a new feature -Make sure to discuss the feature in the #wallet-discussion channel on [Discord](https://discord.iota.org/). +Make sure to discuss the feature on [Discord](https://discord.gg/RjX3jEc7K7). Otherwise, your feature may not be approved at all. ### Building a new feature -To build a new feature, check out a new branch based on the `develop` branch, and be sure to document any public-facing APIs, using Rust code comments. - - -
- -
-Join the wallet Initiative :deciduous_tree: -
- -The [wallet Initiative](https://github.com/iota-community/wallet) is a collaborative effort to improve the wallet developer experience by focussing on the following goals: - -- Quality Assurance and Quality Control -- Documentation -- Benchmarks -- RFCs -- Node usability -- Improvements to modules and libraries - -## How much time is involved - -You can invest as much or as little time as you want into the initiative. - -## What's in it for you - -In return for your time, not only do you get to be a part of the future of IOTA technology, you will also be given a badge on Discord to show others that you're a valuable member of the IOTA community. - -## How to join - -If you're interested in joining, chat to us in the #experience channel on [Discord](https://discord.iota.org/). - +To build a new feature, check out a new branch based on the `develop` branch.

@@ -144,18 +111,10 @@ Before submitting a pull request, please follow these steps to have your contrib **Note:** You don't need to open an issue for minor changes such as typos, but you can if you want. -- All public interfaces should have descriptive documentation, including an -example that compiles and passes [documentation tests](https://doc.rust-lang.org/rustdoc/documentation-tests.html) - -- All instances of `unsafe` should have a comment that explains why its use was unavoidable - - All code should be well formatted and linted, passing our [linting continuous integration](https://github.com/bloomwalletio/bloom/blob/develop/.github/workflows/ci.lint.yml) workflow - All code should be well tested, passing (unit _and_ integration tests) both locally and in our [testing continuous integration](https://github.com/bloomwalletio/bloom/blob/develop/.github/workflows/ci.test.yml) workflow -- If your changes include modification or adding of dependencies, once your PR is approved it must then be merged into a `snyk/branch-prefix/branch-name` on the main Bloom repository to test said changes with the [Snyk continuous integration](https://github.com/bloomwalletio/bloom/blob/develop/.github/workflows/ci.snyk.yml) workflow - -- To be compatible with the guidelines of the Eclipse foundation, all code must be licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). This license must be referenced in every crate of the workspace (add [`./LICENSE`] to the crate's top level directory). For Rust crates, every `Cargo.toml` must contain the line `license = "Apache-2.0"`. ### Submitting a pull request @@ -163,9 +122,9 @@ The following is a typical workflow for submitting a new pull request: 1. Fork this repository 2. Create a new branch based on your fork. For example, `git checkout -b fix/my-fix` or ` git checkout -b feat/my-feature`. -3. Run the `rustfmt` command to make sure your code is well formatted +3. Run the `yarn check:types && yarn lint && yarn test:shared` command to make sure your code is well formatted 4. Commit changes and push them to your fork -5. Target your pull request to be merged with `master` +5. Target your pull request to be merged with `develop` If all [status checks](https://help.github.com/articles/about-status-checks/) pass, and the maintainer approves the PR, it will be merged. @@ -178,4 +137,4 @@ If all [status checks](https://help.github.com/articles/about-status-checks/) pa Code of Conduct :clipboard:
-This project and everyone participating in it is governed by the [IOTA Code of Conduct](.github/CODE_OF_CONDUCT.md). +This project and everyone participating in it is governed by the [Bloom Code of Conduct](.github/CODE_OF_CONDUCT.md). diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index d1c3cd30ef..6cdc8bb093 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -11,34 +11,21 @@ body: - type: markdown attributes: value: | - Thank you for helping us make Bloom better, by reporting a bug you have found. This issue may already be reported! Please search on the [issue tracker](https://github.com/iotaledger/firefly/issues?q=is%3Aissue+is%3Aopen+label%3Atype%3Abug) before creating one. This form is for bugs only and not for help or support using this application. Please visit the [help and support discussions forum](https://github.com/iotaledger/firefly/discussions/categories/help-support) or join our [discord](https://discord.iota.org/) for help. + Thank you for helping us make Bloom better, by reporting a bug you have found. This issue may already be reported! Please search on the [issue tracker](https://github.com/bloomwalletio/bloom/issues?q=is%3Aopen+is%3Aissue+label%3Abug-report) before creating one. This form is for bugs only and not for help or support using this application. Please visit the [help and support discussions forum](https://github.com/bloomwalletio/bloom/discussions) or join our [discord](https://discord.gg/RjX3jEc7K7) for help. - type: markdown attributes: value: '## Bloom application details' - - type: dropdown - id: platform - attributes: - label: Platform - description: What platform does this issue occur on? (Select all that apply) - multiple: true - options: - - Desktop - - Mobile - validations: - required: true - - type: input id: version attributes: label: Version description: What version of Bloom are you using? (Select all that apply) - placeholder: "1.4.0" + placeholder: "0.1.0" validations: required: true - - type: markdown attributes: value: '## Issue report' @@ -90,46 +77,40 @@ body: - type: markdown attributes: - value: '## Your machine' + value: '## Error information' - type: dropdown - id: os + id: crash_info attributes: - label: Operating System - description: Which OS does this issue occur on? (Select all that apply) - multiple: true + label: Crash Status + description: Did Bloom crash, hang or freeze? + multiple: false options: - - Linux - - Mac - - Windows - - iOS - - Android + - "None of the above" + - Infinite loading symbol + - Non-responsive + - White screen + - Application closed validations: - required: true + required: true - type: textarea - id: diagnostics + id: error_messages attributes: - label: Diagnostics - description: Paste the information from the Diagnostics popup accessible in the Bloom main menu or settings page. + label: Error Messages + description: Did any error messages display on the screen? If so what was the message? + + - type: textarea + id: error_logs + attributes: + label: Error Logs + description: Paste the latest errors from the error log, accessible in the Bloom main menu or settings page render: shell - type: markdown attributes: value: '## Use of Bloom' - - type: dropdown - id: profile_role - attributes: - label: Developer Profile - description: Are you using a developer profile? - multiple: false - options: - - "No" - - "Yes" - validations: - required: true - - type: dropdown id: profile_type attributes: @@ -142,48 +123,28 @@ body: validations: required: true - - type: dropdown - id: staking_status - attributes: - label: Staking - description: What is the state of staking in your profile? - multiple: false - options: - - Actively staking - - Previously staked - - Never staked - validations: - - type: markdown attributes: - value: '## Error information' + value: '## Your machine' - type: dropdown - id: crash_info + id: os attributes: - label: Crash Status - description: Did Bloom crash, hang or freeze? - multiple: false + label: Operating System + description: Which OS does this issue occur on? (Select all that apply) + multiple: true options: - - "None of the above" - - Infinite loading symbol - - Non-responsive - - White screen - - Application closed + - Linux + - Mac + - Windows validations: - required: true - - - type: textarea - id: error_messages - attributes: - label: Error Messages - description: Did any error messages display on the screen? If so what was the message? + required: true - type: textarea - id: error_logs + id: diagnostics attributes: - label: Error Logs - description: Paste the latest errors from the error log, accessible in the Bloom main menu or settings page + label: Diagnostics + description: Paste the information from the Diagnostics popup accessible in the Bloom main menu or settings page. render: shell - type: markdown diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ee709f1b1c..72ca846dc5 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -9,9 +9,6 @@ contact_links: - name: General feedback url: https://github.com/bloomwalletio/bloom/discussions/categories/general about: Leave us some feedback - - name: Translation issues - url: https://crowdin.com/project/bloom-wallet - about: Issues with translations can be resolved on Crowdin - name: Join our Discord - url: https://discord.iota.org/ - about: Chat with the devs and the IF community + url: https://discord.gg/RjX3jEc7K7 + about: Chat with the devs and the Bloom community diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index 7f052dea48..b954fe6e3c 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -2,7 +2,6 @@ If you have a general or technical question, you can use one of the following resources instead of submitting an issue: -- [**Developer documentation:**](https://docs.iota.org/) For official information about developing with IOTA technology -- [**Discord:**](https://discord.iota.org/) For real-time chats with the developers and community members -- [**IOTA cafe:**](https://iota.cafe/) For technical discussions with the Research and Development Department at the IOTA Foundation -- [**StackExchange:**](https://iota.stackexchange.com/) For technical and troubleshooting questions \ No newline at end of file +- [**IOTA documentation:**](https://wiki.iota.org/) For official information about developing with IOTA technology +- [**Developer documentation:**](https://docs.bloomwallet.io/) For official information about developing with Bloom wallet +- [**Discord:**](https://discord.gg/RjX3jEc7K7) For real-time chats with the developers and community members diff --git a/README.md b/README.md index caddfb144e..dc63f4f244 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,7 @@

Bloom

- Discord - StackExchange + Discord

@@ -33,7 +32,7 @@ Bloom is a simple and secure wallet for managing your digital assets in the IOTA There are a few options to install Bloom: - Download from [official Bloom website](https://bloomwallet.io) -- Download from the latest [GitHub release](https://github.com/bloomwalletio/bloom/releases/tag/desktop-2.0.0) +- Download from the latest [GitHub release](https://github.com/bloomwalletio/bloom/releases) - Build from the source code within this repository (see [here](https://github.com/bloomwalletio/bloom/blob/develop/packages/desktop/README.md)) ## Contributing diff --git a/packages/shared/src/lib/auxiliary/deep-link/handlers/handleDeepLink.ts b/packages/shared/src/lib/auxiliary/deep-link/handlers/handleDeepLink.ts index 37dd91b63e..2a7b5e65d9 100644 --- a/packages/shared/src/lib/auxiliary/deep-link/handlers/handleDeepLink.ts +++ b/packages/shared/src/lib/auxiliary/deep-link/handlers/handleDeepLink.ts @@ -20,7 +20,7 @@ import { URL_CLEANUP_REGEX } from '../constants' import { closeDrawer } from '../../../../../../desktop/lib/auxiliary/drawer' /** - * Parses an IOTA deep link, i.e. a URL that begins with the app protocol i.e "firefly://". + * Parses an Bloom deep link, i.e. a URL that begins with the app protocol i.e "bloom://". * @method parseDeepLinkRequest * @param {string} input The URL that was opened by the user. * @returns {void} diff --git a/packages/shared/src/lib/auxiliary/wallet-connect/constants/wallet-metadata.constant.ts b/packages/shared/src/lib/auxiliary/wallet-connect/constants/wallet-metadata.constant.ts index b29db6f871..2a6953fd6f 100644 --- a/packages/shared/src/lib/auxiliary/wallet-connect/constants/wallet-metadata.constant.ts +++ b/packages/shared/src/lib/auxiliary/wallet-connect/constants/wallet-metadata.constant.ts @@ -1,6 +1,6 @@ export const WALLET_METADATA = { - name: 'Firefly Wallet', - description: 'This is a very very secure and pretty Wallet', - url: 'https://firefly.iota.org/', + name: 'Bloom Wallet', + description: 'Simple and secure web3 wallet for the IOTA and Shimmer ecosystem', + url: 'https://bloomwallet.io/', icons: [], } diff --git a/packages/shared/src/lib/core/app/constants/is-system-in-dark-mode.constant.ts b/packages/shared/src/lib/core/app/constants/is-system-in-dark-mode.constant.ts index 12642ece9c..1bfffea963 100644 --- a/packages/shared/src/lib/core/app/constants/is-system-in-dark-mode.constant.ts +++ b/packages/shared/src/lib/core/app/constants/is-system-in-dark-mode.constant.ts @@ -1,7 +1,7 @@ /** * NOTE: This media query is performed only once to help make the UX * consistent across OS platforms. To be specific, it ensures that users - * are required to restart Firefly for system theme changes to take effect. + * are required to restart Bloom for system theme changes to take effect. * This is because the behaviour of this media query is different among platforms, * e.g. queries on MacOS result in up-to-date information whereas Linux-based platforms * result in stale information.