From 8caad9cf897361a3c311bdd7985fde2d8fae2d1a Mon Sep 17 00:00:00 2001 From: Dolasinska Date: Tue, 19 Sep 2023 12:41:31 +0200 Subject: [PATCH 1/7] update documentation --- CONTRIBUTING.md | 25 +++++++------------------ README.md | 5 ++++- 2 files changed, 11 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 892a2d020..eebea3e62 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,7 @@ # Contributing to Finastra Design System -Want to file a bug, contribute some code, or improve documentation? Excellent! 🤗❤️ -Here are some guidelines to make the most out of your help. +Contribution to Finastra Design System is based on a community support model. This means you’re welcome not only to submit and discuss ideas but also deliver new features and bug fixes. If you’re willing to contribute, please have a look at the below guidelines. -- [Contributing to Finastra Design System](#contributing-to-finastra-design-system) - [ Asking Questions](#-asking-questions) - [ Issues and Bugs](#-issues-and-bugs) - [ Feature Requests](#-feature-requests) @@ -11,37 +9,28 @@ Here are some guidelines to make the most out of your help. ## Asking Questions -At the moment we only have a Microsoft Teams' channel dedicated to questions. If you're not part of the organization, you can still send your questions by mail to [UXG - Questions](206630c8.finastra.com@emea.teams.ms). +Should you have any questions or concerns, just submit a new GitHub Discussion. Before doing so, review the already answered topics to minimize duplicates. ## Issues and Bugs -If you discover a bug along your way, you can help by filling a Github issue. -Before submitting it, please consider the following steps: +If you discover a bug along your way, start by filling a GitHub Issue. Before submitting it, please consider the following steps: -- Check you are using the latest version +- Check you are using the latest version of the repository - Make sure the bug is not already covered in the list of open issues - Reproduce the issue in a live editor like [StackBlitz](https://stackblitz.com/) or [CodePen](https://codepen.io/) - Take screenshots if it's a UI issue - Provide the informations requested in the [bug report template](https://github.com/finastra/finastra-design-system/issues/new?template=bug_report.md) -Then the process of reviewing, planning and hopefully fixing your issue will start. - ## Feature Requests -You experienced frustation when trying to achieve some design using the theme? -You identified some components that could help other developpers? +Have you experienced frustration when trying to achieve a design using the theme? Have you identified components that could help other developers? Open a GitHub [feature request](https://github.com/finastra/finastra-design-system/issues/new?template=feature_request.md) -You will be requested to fill a form, describing clearly and concisely your problem. We will discuss your suggestion to understand the need and optimize the solution. - ## Submission Guidelines -Before creating a new pull request please make sure there is no related ongoing work by searching the [GitHub issues](https://github.com/finastra/finastra-design-system/issues) and [Github PRs](https://github.com/finastra/finastra-design-system/pulls) as well. -If you find something similar, join the discussion and consider contributing to it. -If nothing match your search, then create a new issue accordingly ([Issues and Bugs](#issues), [Feature Requests](#features)). -When your issue is validated and you are assigned to it, you can start with those simple steps: +All code submissions require review, this is done through GitHub Pull Requests. Before creating a new pull request please make sure there is no related ongoing work by searching the [GitHub issues](https://github.com/finastra/finastra-design-system/issues) and [Github PRs](https://github.com/finastra/finastra-design-system/pulls) as well. If you find something similar, join the discussion and consider contributing to it. -- Fork the repository by cliking the Fork button in the top right corner. +- Fork the repository by clicking the Fork button in the top right corner. - Go to your repository and clone your fork ```sh diff --git a/README.md b/README.md index 781247417..c1da861f8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![](./.github/assets/banner_home.png) -Welcome to the [Finastra design system](https://design.fusionfabric.cloud/) repository. You will find here all the assets and ressources to **build applications quickly and consistently**. It will also help you easily applying **Finastra branding and UX best practices**. +Welcome to the Finastra Design System repository. You will find here all the assets and ressources to **build applications quickly and consistently**. It will also help you easily applying **Finastra branding and UX best practices**. # 🌍 For web @@ -36,3 +36,6 @@ A Microsoft Power BI theme specified in JSON. Want to file a bug, contribute some code, or improve documentation? Excellent! Consider reading our [contribution guidelines](./CONTRIBUTING.md). + +# Finastra Design System page +Please note that the [Finastra design system](https://design.fusionfabric.cloud/) web site will be closed down. \ No newline at end of file From a9984d24da07871c2af763d09ea447e5198b24d6 Mon Sep 17 00:00:00 2001 From: Dolasinska Date: Tue, 19 Sep 2023 13:32:04 +0200 Subject: [PATCH 2/7] update documentation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c1da861f8..349b4f896 100644 --- a/README.md +++ b/README.md @@ -38,4 +38,4 @@ Want to file a bug, contribute some code, or improve documentation? Excellent! Consider reading our [contribution guidelines](./CONTRIBUTING.md). # Finastra Design System page -Please note that the [Finastra design system](https://design.fusionfabric.cloud/) web site will be closed down. \ No newline at end of file +Please note that due to dissolving the UXG team the [Finastra design system](https://design.fusionfabric.cloud/) web site will be closed down by the end of October 2023. \ No newline at end of file From a5f21c82552eab9a874a4ea3a04c12cae8dc07d2 Mon Sep 17 00:00:00 2001 From: Dolasinska Date: Tue, 19 Sep 2023 19:58:10 +0200 Subject: [PATCH 3/7] update documentation --- CONTRIBUTING.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eebea3e62..f951b03b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,10 @@ # Contributing to Finastra Design System -Contribution to Finastra Design System is based on a community support model. This means you’re welcome not only to submit and discuss ideas but also deliver new features and bug fixes. If you’re willing to contribute, please have a look at the below guidelines. +Contribution to Finastra Design System is based on a community support model. This means everybody's welcome to: +- submit and discuss ideas/questions +- deliver new features and bug fixes +- review and comment pull requests created by other community members. +Moreover, the Finastra UX Services team will no longer develop features or fix bugs raised by other teams. However, we'll review and comment newly commited code to ensure the good practices and coding standards are in place. Therefore, if you're willing to contribute, please have a look at the below guidelines. - [ Asking Questions](#-asking-questions) - [ Issues and Bugs](#-issues-and-bugs) @@ -9,22 +13,23 @@ Contribution to Finastra Design System is based on a community support model. Th ## Asking Questions -Should you have any questions or concerns, just submit a new GitHub Discussion. Before doing so, review the already answered topics to minimize duplicates. +Should you have any questions or concerns, just submit a new GitHub Discussion to allow the community to give their feedback. If you feel like answering others' questions, that's more than welcome! Please bear in mind that before sumbitting a new discussion, you should review the already answered topics to minimize duplicates. ## Issues and Bugs -If you discover a bug along your way, start by filling a GitHub Issue. Before submitting it, please consider the following steps: +If you discover a bug along your way, start by filling a GitHub Issue. This way you ensure the transparency to other community members and make it easier to track the progress of fixing it. Before submitting a bug, please consider the following steps: - Check you are using the latest version of the repository - Make sure the bug is not already covered in the list of open issues - Reproduce the issue in a live editor like [StackBlitz](https://stackblitz.com/) or [CodePen](https://codepen.io/) - Take screenshots if it's a UI issue - Provide the informations requested in the [bug report template](https://github.com/finastra/finastra-design-system/issues/new?template=bug_report.md) +- Once you have the fix ready, create a PR so that the community members can provide their feedback ## Feature Requests -Have you experienced frustration when trying to achieve a design using the theme? Have you identified components that could help other developers? -Open a GitHub [feature request](https://github.com/finastra/finastra-design-system/issues/new?template=feature_request.md) +Have you encountered a feature gap in the Finastra Design System? Do you have ideas on how to make the components more functional and user friendly? +Open a GitHub [feature request](https://github.com/finastra/finastra-design-system/issues/new?template=feature_request.md) for tracking purposes and follow Submission Guidelines below to enrich the repository with your code. ## Submission Guidelines From 9edbe4dc79f44c8a646e1be72e15bf827da2d14c Mon Sep 17 00:00:00 2001 From: Dolasinska Date: Tue, 19 Sep 2023 20:04:24 +0200 Subject: [PATCH 4/7] update documentation --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 349b4f896..151241d6a 100644 --- a/README.md +++ b/README.md @@ -38,4 +38,5 @@ Want to file a bug, contribute some code, or improve documentation? Excellent! Consider reading our [contribution guidelines](./CONTRIBUTING.md). # Finastra Design System page -Please note that due to dissolving the UXG team the [Finastra design system](https://design.fusionfabric.cloud/) web site will be closed down by the end of October 2023. \ No newline at end of file + +Please note that due to dissolving the Finastra UXG team the [Finastra design system](https://design.fusionfabric.cloud/) web site will be closed down by the end of October 2023. However, this repository will stay alive thanks to the engagement of the community members. \ No newline at end of file From 3127a3b18bf64c1bcf5aae3387d082cf36d58a75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dagmara=20Do=C5=82asi=C5=84ska?= <56064283+dagmaradolasinska@users.noreply.github.com> Date: Tue, 26 Sep 2023 15:06:33 +0200 Subject: [PATCH 5/7] Update CONTRIBUTING.md --- CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f951b03b6..bfe1be69d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,10 @@ # Contributing to Finastra Design System -Contribution to Finastra Design System is based on a community support model. This means everybody's welcome to: -- submit and discuss ideas/questions +Contribution to Finastra Design System is now based on a community support model. This means everybody's welcome to: +- submit and discuss ideas and questions - deliver new features and bug fixes -- review and comment pull requests created by other community members. -Moreover, the Finastra UX Services team will no longer develop features or fix bugs raised by other teams. However, we'll review and comment newly commited code to ensure the good practices and coding standards are in place. Therefore, if you're willing to contribute, please have a look at the below guidelines. +- review and comment on pull requests created by other community members +The Finastra FFDC UX Services team will no longer develop features or fix bugs raised by other teams. However, we'll review and comment on newly committed code to ensure good practices and coding standards are in place. Therefore, if you're willing to contribute, please have a look at the below guidelines. - [ Asking Questions](#-asking-questions) - [ Issues and Bugs](#-issues-and-bugs) @@ -13,17 +13,17 @@ Moreover, the Finastra UX Services team will no longer develop features or fix b ## Asking Questions -Should you have any questions or concerns, just submit a new GitHub Discussion to allow the community to give their feedback. If you feel like answering others' questions, that's more than welcome! Please bear in mind that before sumbitting a new discussion, you should review the already answered topics to minimize duplicates. +Should you have any questions or concerns, just submit a new GitHub [Discussion](https://github.com/Finastra/finastra-design-system/discussions) to allow the community to give their feedback. If you feel like answering others' questions, that's more than welcome! Please bear in mind that before submitting a new discussion, you should review the already answered topics to minimize duplicates. ## Issues and Bugs -If you discover a bug along your way, start by filling a GitHub Issue. This way you ensure the transparency to other community members and make it easier to track the progress of fixing it. Before submitting a bug, please consider the following steps: +If you discover a bug along your way, start by filing a GitHub Issue. This way you ensure transparency to other community members and make it easier to track the progress of the fix. Before submitting a bug, please consider the following steps: - Check you are using the latest version of the repository - Make sure the bug is not already covered in the list of open issues - Reproduce the issue in a live editor like [StackBlitz](https://stackblitz.com/) or [CodePen](https://codepen.io/) - Take screenshots if it's a UI issue -- Provide the informations requested in the [bug report template](https://github.com/finastra/finastra-design-system/issues/new?template=bug_report.md) +- Provide the information requested in the [bug report template](https://github.com/finastra/finastra-design-system/issues/new?template=bug_report.md) - Once you have the fix ready, create a PR so that the community members can provide their feedback ## Feature Requests @@ -75,7 +75,7 @@ All code submissions require review, this is done through GitHub Pull Requests. > npm run stylelint ``` -- fix the presented errors / problems if any +- fix the presented errors or problems if any - Commit your code, add a commit message following [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) guidelines ```sh From 3238c94497aded91a0b19562d2283e025ab43dac Mon Sep 17 00:00:00 2001 From: Dolasinska Date: Tue, 26 Sep 2023 15:14:43 +0200 Subject: [PATCH 6/7] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 151241d6a..60fc090b3 100644 --- a/README.md +++ b/README.md @@ -32,11 +32,11 @@ A Microsoft Power BI theme specified in JSON. [Learn more](./packages/fds-theme-powerbi/README.md) +## Finastra Design System page + +Please note that due to dissolving the Finastra UXG team the [Finastra design system](https://design.fusionfabric.cloud/) web site will be closed down by the end of October 2023. However, this repository will stay alive thanks to the engagement of the community members. + # 💌 Want to help? Want to file a bug, contribute some code, or improve documentation? Excellent! Consider reading our [contribution guidelines](./CONTRIBUTING.md). - -# Finastra Design System page - -Please note that due to dissolving the Finastra UXG team the [Finastra design system](https://design.fusionfabric.cloud/) web site will be closed down by the end of October 2023. However, this repository will stay alive thanks to the engagement of the community members. \ No newline at end of file From 9429e458cf324ee0149a13f2f81a855231d9e646 Mon Sep 17 00:00:00 2001 From: Dolasinska Date: Mon, 23 Oct 2023 14:22:58 +0200 Subject: [PATCH 7/7] update doc --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 60fc090b3..dc7766f03 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,6 @@ A Microsoft Power BI theme specified in JSON. [Learn more](./packages/fds-theme-powerbi/README.md) -## Finastra Design System page - -Please note that due to dissolving the Finastra UXG team the [Finastra design system](https://design.fusionfabric.cloud/) web site will be closed down by the end of October 2023. However, this repository will stay alive thanks to the engagement of the community members. - # 💌 Want to help? Want to file a bug, contribute some code, or improve documentation?