diff --git a/README.md b/README.md index b1df7ed73..d9d7530b3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # B01LER + ![B01LER_UpdateImg_1100-480@2x](https://github.com/deven-org/boiler/assets/122102805/7f55e1fd-955f-4c9f-890d-3d5a03f5c3aa) ## :page_with_curl: Content + - [B01LER](#b01ler) - [:page_with_curl: Content](#page_with_curl-content) - [:star: Introduction](#star-introduction) @@ -37,17 +39,28 @@ - [:green_heart: Code of conduct](#green_heart-code-of-conduct) ## :star: Introduction -B01LER is a fully customisable design system (DS) that enables you to easily create cohesive and consistent digital products across multiple platforms and brands. -B01LER provides pre-built components that exist in design in the form of a [component library in Figma](https://www.figma.com/file/kG44mSWhEp2VcMvMqbJrRY/B01LER-%5Bv0.2--alpha-release%5D?type=design&node-id=1134%3A44297&mode=design&t=ZatzD7omF9pxalvP-1) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/B01LER%20[v0.2%20-alpha%20release].fig)), as well as in code in a repository (the one you have opened right now), which is also [displayed in the web using Storybook](https://b01ler.onrender.com/). Both the components in design and in code are connected via a token system. +B01LER is a fully customisable design system (DS) that enables you to easily create cohesive and consistent digital +products across multiple platforms and brands. -A token system is a collection of values which represent the visual properties of a design system, such as typography, color and spacing. +B01LER provides pre-built components that exist in design in the form of a +[component library in Figma](https://www.figma.com/community/file/1354113903886620358/b01ler), as well as in code in a +repository (the one you have opened right now), which is also +[displayed in the web using Storybook](https://b01ler.onrender.com/). Both the components in design and in code are +connected via a token system. -Utilizing tokens, B01LER is simultaneously consistent and flexible. By changing the tokens, you have the power to change the appearance of the whole design, including all the components and all the digital products build with it. In Figma and in code. +A token system is a collection of values which represent the visual properties of a design system, such as typography, +color and spacing. -Overall, B01LER is a powerful tool that helps you work smarter, not harder. By streamlining the design and development processes B01LER empowers you to create better products faster. +Utilizing tokens, B01LER is simultaneously consistent and flexible. By changing the tokens, you have the power to change +the appearance of the whole design, including all the components and all the digital products build with it. In Figma +and in code. + +Overall, B01LER is a powerful tool that helps you work smarter, not harder. By streamlining the design and development +processes B01LER empowers you to create better products faster. ### Benefits of B01LER + 1. Increased efficiency in building design systems on brand, because semantic structure and architecture are pre-built 2. Increased efficiency, through automated processes. Documentation, DEV Handover, and more 3. Increased effectivity, because the time saved on building all the components can be used to build features right away @@ -55,72 +68,131 @@ Overall, B01LER is a powerful tool that helps you work smarter, not harder. By s 5. Immense cost savings, because the DS ramp-up phase is reduced from multiple months to days ### Common misconceptions + #### Accessibility of Web Components -Some articles claim, that Web Components are not accessible or that they are not complying with standard accessibility guidelines. The argument says that assistive technologies like screenreaders can not access the shadow DOM and for example are not able to "see" aria or role attributes that are needed to make components accessible. This is wrong. Modern screenreaders are not "looking" at the DOM. Instead they are accessing the accessibility tree, which is provided by the browser and also contains information from the shadow DOM. + +Some articles claim, that Web Components are not accessible or that they are not complying with standard accessibility +guidelines. The argument says that assistive technologies like screenreaders can not access the shadow DOM and for +example are not able to "see" aria or role attributes that are needed to make components accessible. This is wrong. +Modern screenreaders are not "looking" at the DOM. Instead they are accessing the accessibility tree, which is provided +by the browser and also contains information from the shadow DOM. ## :art: Resources -- [Check out our Figma File](https://www.figma.com/file/kG44mSWhEp2VcMvMqbJrRY/B01LER-%5Bv0.2--alpha-release%5D?type=design&node-id=1134%3A44297&mode=design&t=ZatzD7omF9pxalvP-1) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/B01LER%20[v0.2%20-alpha%20release].fig)) + +- [Check out our Figma File](https://www.figma.com/community/file/1354113903886620358/b01ler) - [Have a look at our components in Storybook](https://b01ler.onrender.com/) ## :tipping_hand_person: Help & Feedback + ### Slack -Slack is our main internal communications channel and will most likely be the place where you can reach us best. Join the [#boiler](https://song-asg.slack.com/archives/C062PQ9DJTD) channel and say hi πŸ‘‹ (you need to be part of the Accenture Org to join). + +Slack is our main internal communications channel and will most likely be the place where you can reach us best. Join +the [#boiler](https://song-asg.slack.com/archives/C062PQ9DJTD) channel and say hi πŸ‘‹ (you need to be part of the +Accenture Org to join). ### Teams -We are also on Microsoft Teams. Join the [B01LER](https://teams.microsoft.com/l/team/19%3ABvYMwUq382hbRn7dJyucR3DN4KORS1HjIZl3n5GqE9k1%40thread.tacv2/conversations?groupId=2d176fa2-6d3a-4c70-a986-d05b5977678f&tenantId=e0793d39-0939-496d-b129-198edd916feb) channel and say hi πŸ‘‹ (you need to be part of the Accenture Org to join). + +We are also on Microsoft Teams. Join the +[B01LER](https://teams.microsoft.com/l/team/19%3ABvYMwUq382hbRn7dJyucR3DN4KORS1HjIZl3n5GqE9k1%40thread.tacv2/conversations?groupId=2d176fa2-6d3a-4c70-a986-d05b5977678f&tenantId=e0793d39-0939-496d-b129-198edd916feb) +channel and say hi πŸ‘‹ (you need to be part of the Accenture Org to join). ### Email -You can send us messages via [hello@boilerds.com](mailto:hello@boilerds.com), which the team will try to respond to as quickly as possible. + +You can send us messages via [hello@boilerds.com](mailto:hello@boilerds.com), which the team will try to respond to as +quickly as possible. ### B01LER Monthly -Join the B01LER Monthly Session and ask questions, if you have any. The session takes place on the last Thursday of each month from 4 PM to 4:30 PM (CET). You can add the session to your calendar by following the guide in the pinned post of our dedicated [Teams channel](https://teams.microsoft.com/l/channel/19%3Aca0a1284d8b34c62b80e983ca3af7934%40thread.tacv2/Monthly%20Session?groupId=2d176fa2-6d3a-4c70-a986-d05b5977678f&tenantId=e0793d39-0939-496d-b129-198edd916feb) for the session (you need to be part of the Accenture Org to join). + +Join the B01LER Monthly Session and ask questions, if you have any. The session takes place on the last Thursday of each +month from 4 PM to 4:30 PM (CET). You can add the session to your calendar by following the guide in the pinned post of +our dedicated +[Teams channel](https://teams.microsoft.com/l/channel/19%3Aca0a1284d8b34c62b80e983ca3af7934%40thread.tacv2/Monthly%20Session?groupId=2d176fa2-6d3a-4c70-a986-d05b5977678f&tenantId=e0793d39-0939-496d-b129-198edd916feb) +for the session (you need to be part of the Accenture Org to join). ### Questions, feedback or feature requests? -We are happy about anyone who wants to participate in our community. To ask questions or give us feedback please [open a discussion on GitHub](https://github.com/deven-org/boiler/discussions). For feature requests please use our [feature request template](https://github.com/deven-org/boiler/issues/new?assignees=&labels=%F0%9F%9A%A8+new%3A%3Aenhancement&projects=deven-org%2F3&template=2_feature_request.yaml&title=%5BFeature+Request%5D%3A+). + +We are happy about anyone who wants to participate in our community. To ask questions or give us feedback please +[open a discussion on GitHub](https://github.com/deven-org/boiler/discussions). For feature requests please use our +[feature request template](https://github.com/deven-org/boiler/issues/new?assignees=&labels=%F0%9F%9A%A8+new%3A%3Aenhancement&projects=deven-org%2F3&template=2_feature_request.yaml&title=%5BFeature+Request%5D%3A+). ### Report an issue -Please let us know in case you are finding any bugs by reporting them with our [bug report template](https://github.com/deven-org/boiler/issues/new?assignees=&labels=%F0%9F%9A%A8+new%3A%3Abug&projects=deven-org%2F3&template=1_bug_report.yaml&title=%5BBug%5D%3A+). The template can also be used to report issues with our documentation. In case you discover a security vulnerability please review our [security policy](/docs/SECURITY.md) for more details on how to report it. + +Please let us know in case you are finding any bugs by reporting them with our +[bug report template](https://github.com/deven-org/boiler/issues/new?assignees=&labels=%F0%9F%9A%A8+new%3A%3Abug&projects=deven-org%2F3&template=1_bug_report.yaml&title=%5BBug%5D%3A+). +The template can also be used to report issues with our documentation. In case you discover a security vulnerability +please review our [security policy](/docs/SECURITY.md) for more details on how to report it. ## :triangular_ruler: Architecture + Get to know about our Architecture [here](./docs/ARCHITECTURE.md). ## :leftwards_arrow_with_hook: Prefixes + BO1LER uses the 'blr' prefix in three main areas: custom component tag names, events and icons ### Components -The names of BO1LER components follow the W3C Custom Elements specification. Component prefixes can easily be customized by updating the exported TAG_NAME in each `renderFunction` file. The `renderFunction` file can be found in the directory of each component in our `ui-library` package. In order for your component to be valid, the name must contain at least one dash, it must start with a lowercase character of the alphabet and it cannot contain reserved tag names that already exist in the HTML spec. For a full list of reserved tag names and more tips on naming Custom Elements, please explore [this guide](https://webcomponents.guide/learn/components/naming-your-components/) to ensure that your naming convention is compliant. + +The names of BO1LER components follow the W3C Custom Elements specification. Component prefixes can easily be customized +by updating the exported TAG_NAME in each `renderFunction` file. The `renderFunction` file can be found in the directory +of each component in our `ui-library` package. In order for your component to be valid, the name must contain at least +one dash, it must start with a lowercase character of the alphabet and it cannot contain reserved tag names that already +exist in the HTML spec. For a full list of reserved tag names and more tips on naming Custom Elements, please explore +[this guide](https://webcomponents.guide/learn/components/naming-your-components/) to ensure that your naming convention +is compliant. ### Events -BO1LER uses custom event names in our components that come prefixed with `blr` by default. This is done to avoid using the same names in HTML. Users may still need to use native events without having to worry about naming collisions. The exported event names can be customized in the [events.ts file](./packages/ui-library/src/globals/events.ts). For example, the focus event can be updated with a new prefix of your choosing by changing the value: + +BO1LER uses custom event names in our components that come prefixed with `blr` by default. This is done to avoid using +the same names in HTML. Users may still need to use native events without having to worry about naming collisions. The +exported event names can be customized in the [events.ts file](./packages/ui-library/src/globals/events.ts). For +example, the focus event can be updated with a new prefix of your choosing by changing the value: ``` export const BlrFocusEventName = 'blrFocus'; ``` ### Icons -The prefixes of our icons can easily be renamed by opening the [index.mjs file](./packages/icons/scripts/index.mjs) in the `icons` directory. This file is responsible for optimizing our icons, assigning a prefix and exporting their type and exporting their keys. Simply replace the value of the variable `withPrefix` with a prefix of your choosing and run `yarn compile:icons` from the root directory for your changes to take effect. Remember to update the test files and the .stories.ts files with your chosen prefix for the app to function as expected. +The prefixes of our icons can easily be renamed by opening the [index.mjs file](./packages/icons/scripts/index.mjs) in +the `icons` directory. This file is responsible for optimizing our icons, assigning a prefix and exporting their type +and exporting their keys. Simply replace the value of the variable `withPrefix` with a prefix of your choosing and run +`yarn compile:icons` from the root directory for your changes to take effect. Remember to update the test files and the +.stories.ts files with your chosen prefix for the app to function as expected. ## :gear: Requirements -1. First you need to install Git. Git is needed to clone the project to your local machine. If you don't have it installed yet you can follow this [installation guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). -2. This project is a Node.js package. You need Node Version 18 or higher in order to run it. Check your installed version with node -v. For more information check out the [Node.js Documentation](https://nodejs.org/en/docs/). -3. If you don't have Yarn installed, please install it (any version, we will pick the right settings later). For more information check out the [Yarn Documentation](https://classic.yarnpkg.com/en/docs). -In addition, you might need to install Corepack. For more information checkout [Corepack Documentation](https://nodejs.org/api/corepack.html). +1. First you need to install Git. Git is needed to clone the project to your local machine. If you don't have it + installed yet you can follow this + [installation guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). +2. This project is a Node.js package. You need Node Version 18 or higher in order to run it. Check your installed + version with node -v. For more information check out the [Node.js Documentation](https://nodejs.org/en/docs/). +3. If you don't have Yarn installed, please install it (any version, we will pick the right settings later). For more + information check out the [Yarn Documentation](https://classic.yarnpkg.com/en/docs). +In addition, you might need to install Corepack. For more information checkout +[Corepack Documentation](https://nodejs.org/api/corepack.html). ### Figma -Figma is a collaborative tool used for designing user interfaces. Figma can be run on any operating system that can run a browser which can help designers, developers and various other stakeholders to collaborate seamlessly. Sharing designs, managing permissions on a granular level and requesting feedback are some of the many features that help teams work in a more agile fashion. + +Figma is a collaborative tool used for designing user interfaces. Figma can be run on any operating system that can run +a browser which can help designers, developers and various other stakeholders to collaborate seamlessly. Sharing +designs, managing permissions on a granular level and requesting feedback are some of the many features that help teams +work in a more agile fashion. ### Tokens Studio -Tokens Studio for Figma (also known as Figma Tokens) is a plugin for Figma that allows users to integrate design tokens into their Figma designs. -Before you start working with B01LER Design System for Figma, make sure to install the Tokens Studio for Figma (Figma Tokens) plugin so you can access and customize the UI kit easily. -The plugin allows both designers and developers to inspect tokens that have been applied to components. An overview of all tokens for a component can be viewed with deep inspect or the specific tokens used for the building blocks of a component can also be viewed +Tokens Studio for Figma (also known as Figma Tokens) is a plugin for Figma that allows users to integrate design tokens +into their Figma designs. Before you start working with B01LER Design System for Figma, make sure to install the Tokens +Studio for Figma (Figma Tokens) plugin so you can access and customize the UI kit easily. + +The plugin allows both designers and developers to inspect tokens that have been applied to components. An overview of +all tokens for a component can be viewed with deep inspect or the specific tokens used for the building blocks of a +component can also be viewed ## :arrow_forward: How to start ### Installation + > **Note:** You need to run terminal as administrator on Windows machines. 1. First, open a terminal and navigate to the folder you want to fork or clone this project @@ -129,7 +201,10 @@ The plugin allows both designers and developers to inspect tokens that have been $ cd git_projects ``` -2. If you want to use B01LER as a starting point for your own design system, the first step is to fork the repository. You can do this via the GitHub web interface and just follow the instructions or read the documentation [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). This step is only required for the initial setup of you repository. +2. If you want to use B01LER as a starting point for your own design system, the first step is to fork the repository. + You can do this via the GitHub web interface and just follow the instructions or read the documentation + [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). + This step is only required for the initial setup of you repository. In case you want to contribute to this repository, the first step is to clone the repository: @@ -156,7 +231,9 @@ The plugin allows both designers and developers to inspect tokens that have been $ yarn start ``` -> Note: This command will also open up Storybook locally. This provides you with a full list of available components that you can experiment with. Each component in Storybook also contains detailed documentation how to use them and the parameters that they can accept. +> Note: This command will also open up Storybook locally. This provides you with a full list of available components +> that you can experiment with. Each component in Storybook also contains detailed documentation how to use them and the +> parameters that they can accept. ### Setup @@ -164,29 +241,48 @@ The plugin allows both designers and developers to inspect tokens that have been 1. First, open your Copy of the B01LER and bookmark Tokens Studio in the Plugins panel. 2. Launch Tokens Studio using 'New Empty File' since no tokens have been defined yet. -3. Connect your repository to Tokens Studio. First, generate and copy a new Personal Access Token in Github. You can use either Tokens (Classic) or 'Fine-grained tokens'. Next, use the copied token to add GitHub as a Sync Provider. Click the 'Settings tab' in Tokens Studio and in the 'Add new menu', select GitHub. Use the Personal Token that you copied to authenticate yourself and to connect your cloned B01LER repository. -4. If the entered credential are correct you will be asked to Pull from git. Please accept this dialog. The tokens tab should now contain all tokens sets of B01LER available. - -Please refer to the 'Getting Started' section in our [Figma file](https://www.figma.com/file/kG44mSWhEp2VcMvMqbJrRY/B01LER-%5Bv0.2--alpha-release%5D?type=design&node-id=1134%3A44297&mode=design&t=ZatzD7omF9pxalvP-1) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/B01LER%20[v0.2%20-alpha%20release].fig)) for more detailed instructions on how to set up the library, configure Figma Tokens Studio and customize the project assets to meet your requirements. - -The 'Getting Started' section also explains the logic behind our token names and enable you to find and change the right tokens when rebranding B01LER or when you want to extend or change some functionality of a component. +3. Connect your repository to Tokens Studio. First, generate and copy a new Personal Access Token in Github. You can use + either Tokens (Classic) or 'Fine-grained tokens'. Next, use the copied token to add GitHub as a Sync Provider. Click + the 'Settings tab' in Tokens Studio and in the 'Add new menu', select GitHub. Use the Personal Token that you copied + to authenticate yourself and to connect your cloned B01LER repository. +4. If the entered credential are correct you will be asked to Pull from git. Please accept this dialog. The tokens tab + should now contain all tokens sets of B01LER available. + +Please refer to the 'Getting Started' section in our +[Figma file](https://www.figma.com/file/kG44mSWhEp2VcMvMqbJrRY/B01LER-%5Bv0.2--alpha-release%5D?type=design&node-id=1134%3A44297&mode=design&t=ZatzD7omF9pxalvP-1) +(the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the +organization can download the file [here](https://boilerds.com/B01LER%20[v0.2%20-alpha%20release].fig)) for more +detailed instructions on how to set up the library, configure Figma Tokens Studio and customize the project assets to +meet your requirements. + +The 'Getting Started' section also explains the logic behind our token names and enable you to find and change the right +tokens when rebranding B01LER or when you want to extend or change some functionality of a component. ### Icon Kit Setup -After you setup the project, you can start implementing your desired icons. B01LER comes with a set of predefined icons in the variety of sizes: small, extra small, extra extra small, medium (default), large, extra large. All the default icons can be seen in our [Storybook](https://b01ler.onrender.com/?path=/docs/foundation-icons--docs). + +After you setup the project, you can start implementing your desired icons. B01LER comes with a set of predefined icons +in the variety of sizes: small, extra small, extra extra small, medium (default), large, extra large. All the default +icons can be seen in our [Storybook](https://b01ler.onrender.com/?path=/docs/foundation-icons--docs). #### Structure -In the project you will find 2 folders containing icons. One of them represents an input folder and the other one - output after compiling. + +In the project you will find 2 folders containing icons. One of them represents an input folder and the other one - +output after compiling. └── packages └── icons // Icon configuration files and a collection of icon files in svg format └── icon-set // Input folder for the icons └── icons-optimized // Output folder (after building icons) -To properly compile icons inside the B01LER project you need to follow a naming convention for them, as an example: `icon_name_md.svg`. In this case we are looking at a medium sized icon `..._md.svg` (each icon has multiple size variations: xxs, xs, sm, md, lg, xl). After you compile your Icons Set, every icon's name will be converted to `blrIconName` and you will be referencing them by this name in your project. +To properly compile icons inside the B01LER project you need to follow a naming convention for them, as an example: +`icon_name_md.svg`. In this case we are looking at a medium sized icon `..._md.svg` (each icon has multiple size +variations: xxs, xs, sm, md, lg, xl). After you compile your Icons Set, every icon's name will be converted to +`blrIconName` and you will be referencing them by this name in your project. #### Adding Icons -For the new icons to work properly, you should add each of your icons in all size variations. -Follow these steps to add your first icon: + +For the new icons to work properly, you should add each of your icons in all size variations. Follow these steps to add +your first icon: > Note: B01LER only supports icons in black and white. @@ -195,6 +291,7 @@ Follow these steps to add your first icon: ```sh $ yarn compile:icons ``` + 2. To check that your icon has been added run your project locally and inspect the Icons tab: ```sh @@ -202,6 +299,7 @@ Follow these steps to add your first icon: ``` #### Changing Icons + It is also possible to just change existing icon file without renaming it. 1. Navigate to `/icon-set` folder @@ -219,13 +317,16 @@ It is also possible to just change existing icon file without renaming it. 5. If now you navigate to the local Storybook and inspect Icons tab, you will see that the icon `blrBook` is updated -> Note: Remember that every icon has multiple files with different icon sizes. You need to replace all of them with new icons in respective sizes. +> Note: Remember that every icon has multiple files with different icon sizes. You need to replace all of them with new +> icons in respective sizes. #### Replacing default Icons -Some of the components have the default icons connected to them (you can see the full list of these components in [Removing Icons](#removing-icons) section), but it is possible to change them. -We will take `packages/ui-library/src/components/checkbox` component as an example in this case. -If you open this folder and navigate to `index.stories.ts` file, inside you will be able to see the default parameters for this component. +Some of the components have the default icons connected to them (you can see the full list of these components in +[Removing Icons](#removing-icons) section), but it is possible to change them. + +We will take `packages/ui-library/src/components/checkbox` component as an example in this case. If you open this folder +and navigate to `index.stories.ts` file, inside you will be able to see the default parameters for this component. ``` const defaultParams: BlrCheckboxType = { @@ -237,7 +338,8 @@ const defaultParams: BlrCheckboxType = { }; ``` -To change the default icon you simply need to replace the value of `checkedIcon` with the name of the icon you want. For example: +To change the default icon you simply need to replace the value of `checkedIcon` with the name of the icon you want. For +example: ``` const defaultParams: BlrCheckboxType ={ @@ -260,7 +362,9 @@ To check that changes have applied do the following: 3. Check the checkbox #### Removing Icons -Removing is slightly more difficult than adding, because there are multiple components which are using some of the icons by default. You can see the full list of these components below: + +Removing is slightly more difficult than adding, because there are multiple components which are using some of the icons +by default. You can see the full list of these components below: - Button Icon - Button Text @@ -273,53 +377,63 @@ Removing is slightly more difficult than adding, because there are multiple comp - TabBar - Toggle Switch -> Note: If you use any of those components, make sure that you either haven't removed the icons they use from the project, or replaced missing icons with yours. +> Note: If you use any of those components, make sure that you either haven't removed the icons they use from the +> project, or replaced missing icons with yours. To remove any icon, simply navigate to `/icon-set` folder, delete icons you don't need in all resolutions and run: - ```sh - $ yarn compile:icons - ``` +```sh +$ yarn compile:icons +``` ## :white_check_mark: How to test + Learn about our testing approach [here](./doc/TESTING.md). ## :toolbox: How to build + > Note: Each command must be run from the root directory of the project The B01LER UI Library can be built using the following command: - ```sh - $ yarn build:ui-library - ``` +```sh +$ yarn build:ui-library +``` -B01LER can also be built with Storybook bundled alongside it which provides you with a sandbox to experiment with our components: +B01LER can also be built with Storybook bundled alongside it which provides you with a sandbox to experiment with our +components: - ```sh - $ yarn build:storybook - ``` +```sh +$ yarn build:storybook +``` -B01LER comes with an example vanilla JS application to demonstrate how easy it is to use components in your app. To build this example app, run the following command: +B01LER comes with an example vanilla JS application to demonstrate how easy it is to use components in your app. To +build this example app, run the following command: - ```sh - $ yarn build:js-example - ``` +```sh +$ yarn build:js-example +``` In the generated `dist` folder, the generated `index.html` file can be opened in the browser to preview our components. ## :rocket: How to deploy + Learn about our approach to deployment [here](./doc/DEPLOYMENT.md). ## :building_construction: How to develop -Note: This is not filled out yet! -... +Note: This is not filled out yet! ... ## :v: Contribute -For a detailed documentation on how to contribute to the B01LER project, have a look at our [contribution guide](./docs/CONTRIBUTING.md). + +For a detailed documentation on how to contribute to the B01LER project, have a look at our +[contribution guide](./docs/CONTRIBUTING.md). ## :page_facing_up: License + This project is licensed under the [MIT license](./LICENSE.md). ## :green_heart: Code of conduct -The B01LER is using the Contributor Covenant Code of Conduct. You can read the whole code of conduct [here](./docs/CODE_OF_CONDUCT.md). + +The B01LER is using the Contributor Covenant Code of Conduct. You can read the whole code of conduct +[here](./docs/CODE_OF_CONDUCT.md). diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 2e27b4aea..b1c5cc295 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,13 +1,20 @@ # Contributing + Welcome to our B01LER Contribution Page! We truly appreciate your interest in contributing to our project! 🎨✨ -Dive into the heart of our project by contributing to its foundational elements: Explore this page to discover ways you can contribute β€” your involvement is greatly appreciated! +Dive into the heart of our project by contributing to its foundational elements: Explore this page to discover ways you +can contribute β€” your involvement is greatly appreciated! -Curious about who can contribute to our project? The answer is simple: everyone is welcome! Whether you're a developer, designer, manager, or administrator of any kind, your contributions are highly valued. We believe in fostering a diverse community where individuals with various skill sets can collaborate to enhance our project. +Curious about who can contribute to our project? The answer is simple: everyone is welcome! Whether you're a developer, +designer, manager, or administrator of any kind, your contributions are highly valued. We believe in fostering a diverse +community where individuals with various skill sets can collaborate to enhance our project. -It's worth noting that we are currently in the alpha stage, and while we enthusiastically welcome contributions, please understand that, at this moment, we may not have the capacity to manage a large influx of them. Your contributions are greatly appreciated as we continue to grow and develop our project! +It's worth noting that we are currently in the alpha stage, and while we enthusiastically welcome contributions, please +understand that, at this moment, we may not have the capacity to manage a large influx of them. Your contributions are +greatly appreciated as we continue to grow and develop our project! ## :page_with_curl: Content + - [Contributing](#contributing) - [:page_with_curl: Content](#page_with_curl-content) - [:new: New contributor guide](#new-new-contributor-guide) @@ -25,24 +32,36 @@ It's worth noting that we are currently in the alpha stage, and while we enthusi - [:mag: Code Review](mag-code-review) ## :new: New contributor guide -> **NOTE:** -> This documentation is focused towards contributions from developers, if you are looking for a guide for design contributions, please read the [contribute documentation in Figma](https://www.figma.com/file/kG44mSWhEp2VcMvMqbJrRY/B01LER-%5Bv0.2--alpha-release%5D?type=design&node-id=9020%3A1058&mode=design&t=ZatzD7omF9pxalvP-1). Apart from code and design contributions, everyone is always invited to contribute by engaging with the community for example by commenting and giving input on issues or by starting and taking part in discussions in GitHub. Another way to contribute is by getting more eyes on the project. Just add a star to our repository! Or, if you are on Figma, add a heart to our Figma community page or leave a comment if you like the project. -To get an overview of the project and how to set it up, read the [README](/README.md). For more details about our Code of Conduct see [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md). Here are some resources to help you get started with open source contributions: +> **NOTE:** This documentation is focused towards contributions from developers, if you are looking for a guide for +> design contributions, please read the +> [contribute documentation in Figma](https://www.figma.com/community/file/1354113903886620358/b01ler). Apart from code +> and design contributions, everyone is always invited to contribute by engaging with the community for example by +> commenting and giving input on issues or by starting and taking part in discussions in GitHub. Another way to +> contribute is by getting more eyes on the project. Just add a star to our repository! Or, if you are on Figma, add a +> heart to our Figma community page or leave a comment if you like the project. + +To get an overview of the project and how to set it up, read the [README](/README.md). For more details about our Code +of Conduct see [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md). Here are some resources to help you get started with open source +contributions: + - [How to install git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) - [How to handle repositories](https://docs.gitlab.com/ee/user/project/repository/) - [Creating an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) - [Creating merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) > **Contribution etiquette:** +> > - While working on your contribution, please do not copy code from other frameworks or libraries > - Make small and frequent commits > - The default language for all written and spoken communication is english -> - Every GitHub issue should have a corresponding branch, and vice versa - every bugfix or code change should already have an issue created for it +> - Every GitHub issue should have a corresponding branch, and vice versa - every bugfix or code change should already +> have an issue created for it > - No code should be merged or pushed to the develop branch without a pull request > - A merge request can only be merged if it has successful test results and at least two approvals ## :arrows_counterclockwise: Contribution process overview + 1. Getting Started 2. Create new issue / select an existing issue 3. Create new branch @@ -52,16 +71,29 @@ To get an overview of the project and how to set it up, read the [README](/READM 7. Code Review ## :arrow_right: Getting started -The best way to get started is by reading the [README](/README.md). It contains links to all other parts of the project documentation, like the [ARCHITECTURE](ARCHITECTURE.md) documentation for example, where one can also find an overview of the projects file structure. + +The best way to get started is by reading the [README](/README.md). It contains links to all other parts of the project +documentation, like the [ARCHITECTURE](ARCHITECTURE.md) documentation for example, where one can also find an overview +of the projects file structure. ## :clipboard: Issues -Before being able to contribute to B01LER, you need to get yourself assigned to an issue. For this you could either apply to solve an existing issue or create a new issue. + +Before being able to contribute to B01LER, you need to get yourself assigned to an issue. For this you could either +apply to solve an existing issue or create a new issue. ### Solve an existing issue -Browse our [existing issues](https://github.com/deven-org/boiler/issues) to find one that interests you. If you would like to work on an issue, leave a comment stating your intent and assign yourself to the issue. If the issue already has an assignee, someone else is likely already working on it. The core team will check your issue to ensures that it is still relevant and give you approval to start working. Waiting for approval makes it less likely to get a rejected pull request. We will do our best to reply to you within a week. + +Browse our [existing issues](https://github.com/deven-org/boiler/issues) to find one that interests you. If you would +like to work on an issue, leave a comment stating your intent and assign yourself to the issue. If the issue already has +an assignee, someone else is likely already working on it. The core team will check your issue to ensures that it is +still relevant and give you approval to start working. Waiting for approval makes it less likely to get a rejected pull +request. We will do our best to reply to you within a week. ### Create a new issue -Before creating a new issue, please [check if your issue already exists](https://github.com/deven-org/boiler/issues). If a related issue doesn't exist, you can open a new issue using the same page. We currently have two issue templates. One is for bugs and the other one for everything else, like new features or also improvements of existing features. + +Before creating a new issue, please [check if your issue already exists](https://github.com/deven-org/boiler/issues). If +a related issue doesn't exist, you can open a new issue using the same page. We currently have two issue templates. One +is for bugs and the other one for everything else, like new features or also improvements of existing features.
How to write a useful issue? @@ -76,26 +108,45 @@ Before creating a new issue, please [check if your issue already exists](https:/ After creating an issue, don’t forget to assign it to yourself. The core team will then check your issue to ensures that your idea fits the scope of the project and leave an approval comment. Waiting for approval makes it less likely to get a rejected pull request. We will do our best to reply to new issues within a week. ### Tips to find issues -- For a first contribution, go to labels / filter by labels and see if there are issues tagged with the `good first issue` label + +- For a first contribution, go to labels / filter by labels and see if there are issues tagged with the + `good first issue` label - Search for the component name of the component you want to work on - Filter by the `πŸ’š contributor issue` label - Filter by the `🚨 new::bug`, `⌨️ dev issue`, `πŸ“‹ task::backlog` and/or `πŸ“‹ task::ready` labels -- Avoid tasks labeld with `⭕️ core team issue`, `🚫 blocker`, `🎨 design issue`, `πŸ“‹ task::planned`, `πŸ“‹ task::inProgress`, `πŸ“‹ task::inReview`, `🦹 needs:contact`, `🦹 needs:documentation`, `🦹 needs:help` and/or `🦹 needs:specs` +- Avoid tasks labeld with `⭕️ core team issue`, `🚫 blocker`, `🎨 design issue`, `πŸ“‹ task::planned`, + `πŸ“‹ task::inProgress`, `πŸ“‹ task::inReview`, `🦹 needs:contact`, `🦹 needs:documentation`, `🦹 needs:help` and/or + `🦹 needs:specs` ## :arrow_heading_down: Branch -For contributions we are using [Gitflow as branching strategy](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow#:~:text=Gitflow%20is%20a%20legacy%20Git,software%20development%20and%20DevOps%20practices). [Here](https://danielkummer.github.io/git-flow-cheatsheet/) you can also find a short cheatsheet about Gitflow. + +For contributions we are using +[Gitflow as branching strategy](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow#:~:text=Gitflow%20is%20a%20legacy%20Git,software%20development%20and%20DevOps%20practices). +[Here](https://danielkummer.github.io/git-flow-cheatsheet/) you can also find a short cheatsheet about Gitflow. ### Branch Naming Convention -The branch name should not exceed a maximum character count of 140. Each branch should follow the following structure: `/_` -- **branchType:** As defined in the Gitflow branching strategy, there are different types of branches. Besides the existing `main` and `develop` branches, the allowed types for newly created branches are: `release`, `hotfix`, `feature` and `fix`. The branch type `fix` is not defined in Gitflow, but is used exactly like a `feature` branch. It was added to be more granular in our naming convention and to differentiate between branches that implement something new (`feature`) and those that change something that already exists (`fix`). +The branch name should not exceed a maximum character count of 140. Each branch should follow the following structure: +`/_` + +- **branchType:** As defined in the Gitflow branching strategy, there are different types of branches. Besides the + existing `main` and `develop` branches, the allowed types for newly created branches are: `release`, `hotfix`, + `feature` and `fix`. The branch type `fix` is not defined in Gitflow, but is used exactly like a `feature` branch. It + was added to be more granular in our naming convention and to differentiate between branches that implement something + new (`feature`) and those that change something that already exists (`fix`). - **issueNumber:** The issue number of your task. For example: `421` -- **summary:** A few words describing the issue. When there are multiple words, you can use a hyphen to link the words. For example: `text-area-storybook-documentation` +- **summary:** A few words describing the issue. When there are multiple words, you can use a hyphen to link the words. + For example: `text-area-storybook-documentation` ## :handshake: Commits -The commits must be compliant with with the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/). The commit header should not exceed a maximum character count of 140. The scope is allowed to be one of the following options: 'all', 'ui-library', 'icons', 'figma-design-tokens', 'tokens', or 'storybook'. + +The commits must be compliant with with the +[Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/). The commit header should not +exceed a maximum character count of 140. The scope is allowed to be one of the following options: 'all', 'ui-library', +'icons', 'figma-design-tokens', 'tokens', or 'storybook'. ## :test_tube: Testing and validating + Please, before submitting any contribution, be sure that your branch is passing all the tests. ```bash @@ -104,8 +155,18 @@ yarn compile ``` ## :arrow_heading_up: Pull Request -Once your contribution is ready, it is time to create a pull request. Once your contribution is ready, it is time to create a pull request. Please create pull requests for the `develop` branch and not for `main`. Please also make sure that pull requests are linked to the related issue by using a keyword and the issue number as explained [here](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) or by using the `Development` field. + +Once your contribution is ready, it is time to create a pull request. Once your contribution is ready, it is time to +create a pull request. Please create pull requests for the `develop` branch and not for `main`. Please also make sure +that pull requests are linked to the related issue by using a keyword and the issue number as explained +[here](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) +or by using the `Development` field. ## :mag: Code Review -After you created a pull request, your code will be reviewed by the B01LER core team. Once the PR has two approvals, your code will be merged to develop and will be part of a future release. -In case we find things we would like you to change we will leave comments. We kindly ask you to update your pull request in regards of the requested changes. Once all comments have been solved the pull request will be merged. We will try our best to respond within a week to new pull requests. Contributors are also invited to review other contributors pull requests, but in the end at least one member of the core team needs to approve it, before it can be merged. + +After you created a pull request, your code will be reviewed by the B01LER core team. Once the PR has two approvals, +your code will be merged to develop and will be part of a future release. In case we find things we would like you to +change we will leave comments. We kindly ask you to update your pull request in regards of the requested changes. Once +all comments have been solved the pull request will be merged. We will try our best to respond within a week to new pull +requests. Contributors are also invited to review other contributors pull requests, but in the end at least one member +of the core team needs to approve it, before it can be merged. diff --git a/docs/GETSTARTED.md b/docs/GETSTARTED.md index ae1acafdc..6c49ec1f7 100644 --- a/docs/GETSTARTED.md +++ b/docs/GETSTARTED.md @@ -1,7 +1,11 @@ # Get Started -Welcome to the B01LER team! πŸ‘‹ We are thrilled to have you on board. This "Get Started" guide is designed to make your onboarding process smooth and enjoyable and to learn about all the neccessary organizational aspects. Whether you're a seasoned professional or a newcomer, we've got you covered. Let's dive in and unleash the potential of B01LER together! + +Welcome to the B01LER team! πŸ‘‹ We are thrilled to have you on board. This "Get Started" guide is designed to make your +onboarding process smooth and enjoyable and to learn about all the neccessary organizational aspects. Whether you're a +seasoned professional or a newcomer, we've got you covered. Let's dive in and unleash the potential of B01LER together! ## Content + - [Team Overview](#team-overview) - [Designers](#designers) - [Developlers](#developers) @@ -14,12 +18,15 @@ Welcome to the B01LER team! πŸ‘‹ We are thrilled to have you on board. This "Get - [Link Archive](#link-archive) ## Team Overview + ### Designers + - [Lars Erbach](https://github.com/larserbach) (Lead) - [Marcel Doering](https://github.com/m-nti) (Stand-in lead) - [Yik Cun Chung](https://github.com/yikcunchung) ### Developers + - [Christian Hoffmann](https://github.com/ChristianHoffmannS2) (Lead) - [David Kennedy](https://github.com/davidken91) (Stand-in lead) - [Manuel Seemann](https://github.com/seemann) @@ -30,11 +37,16 @@ Welcome to the B01LER team! πŸ‘‹ We are thrilled to have you on board. This "Get - [Roman Yakovliev](https://https://github.com/veilvokay) ### Product & Project Management + - [Thorben Hartmann](https://github.com/thrbnhrtmnn) (Lead, community leader) - [AnΔ‘elka DakiΔ‡](https://github.com/angelicahoyss) (Stand-in lead, community leader) ## Regular Meetings -All regular B01LER team meetings are in our [B01LER Core calendar](https://myemail.accenture.com/calendar/group/accenture.com/boiler-core/view/workweek). The only exception is the B01LER Monthly, which is part of the [B01LER calendar](https://myemail.accenture.com/calendar/group/accenture.com/boiler-ds/view/workweek). + +All regular B01LER team meetings are in our +[B01LER Core calendar](https://myemail.accenture.com/calendar/group/accenture.com/boiler-core/view/workweek). The only +exception is the B01LER Monthly, which is part of the +[B01LER calendar](https://myemail.accenture.com/calendar/group/accenture.com/boiler-ds/view/workweek). | Meeting Name | When | Who | Why | | ---------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | @@ -46,11 +58,12 @@ All regular B01LER team meetings are in our [B01LER Core calendar](https://myema | B01LER Pair Programming Hour | Fridays | Everyone from the B01LER (Dev) Team that wants to join | Collaborate and learn from each other by tackling coding challanges together | | B01LER Open Door | Mondays & Wednesdays | Everyone from the B01LER (Dev) Team that wants to join | Giving guidance and/or answering questions about issues junior devs are working on | | B01LER Pre-Planning | Thursdays | B01LER Leadership (and/or stand-ins) | Discuss objectives and prepare a set of issues to finish int he next iteration | -| B01LER Weekly Checkup | Mondays | B01LER Leadership (and/or stand-ins) | Discuss and decide on general product topics and check the roadmap | -| B01LER Marketing Weekly | Mondays | B01LER Leadership (and/or stand-ins) | Discuss and decide on general marketing topics | +| B01LER Weekly Checkup | Mondays | B01LER Leadership (and/or stand-ins) | Discuss and decide on general product topics and check the roadmap | +| B01LER Marketing Weekly | Mondays | B01LER Leadership (and/or stand-ins) | Discuss and decide on general marketing topics | | B01LER Monthly | Last Thursday of a month | Everyone who wants to join | Giving an update, answering questions and sometimes deep dives into specific topics | ## Communication Channels + Here is a list of all our communicataion channels and what we are using them for. | Tool | Channel | Usage | @@ -66,28 +79,60 @@ Here is a list of all our communicataion channels and what we are using them for | Mailing List | boiler.dev.notifications@accenture.com | Mailing list to receive notifications from dev services like GitHub or Render, reaches developers and Product & Project lead | ## Access Checklist -Here is a checklist with all the accesses that new colleages need when working in the B01LER project. Every entry has a description on how to recieve access and a whom to contact. -- [ ] **GitHub** - Access to the [deven-org](https://github.com/orgs/deven-org/people) and the [b01ler team](https://github.com/orgs/deven-org/teams/bo1ler) can be provided by an any of the team leads or other org-owners. Access to the deven-org also results in access to the [B01LER Project](https://github.com/orgs/deven-org/projects/3/views/1?pane=info). -- [ ] **Figma** - Everyone with an Accenture email address should be able to view the [B01LER DS Figma team](https://www.figma.com/files/1248234047942466966/team/1290961933739934842) after joining the Accenture Global Figma organisation. Select "Use single sign-on" in the login and enter your Accenture-Mail to join the organisation. For Editing rights or when encountering problems, contact the design lead, design lead stand-in or the Product & Project Management lead. -- [ ] **Outlook groups** - Access to the [B01LER Core](https://outlook.office365.com/groups/accenture.com/boiler-core/members) and the [B01LER](https://outlook.office365.com/groups/accenture.com/boiler-ds/members) Outlook group can be provided by any of the leads or stand-ins. With the invite, new colleagues will also be added to the B01LER Teams channel. -- [ ] **Slack channels** - All Slack channels are open to join for anyone in the song-asg.slack org and everyone already on the channels can add new members, to get access to the org, a UHD ticket has to be created. -- [ ] **Mailing lists** - Access to the mailing lists can be provided by the product & project management lead and stand-in. -- [ ] **Parabol** - Access to [Parabol team](https://action.parabol.co/team/lk4SUDAJz2/) can be provided by the product & project management lead. + +Here is a checklist with all the accesses that new colleages need when working in the B01LER project. Every entry has a +description on how to recieve access and a whom to contact. + +- [ ] **GitHub** - Access to the [deven-org](https://github.com/orgs/deven-org/people) and the + [b01ler team](https://github.com/orgs/deven-org/teams/bo1ler) can be provided by an any of the team leads or other + org-owners. Access to the deven-org also results in access to the + [B01LER Project](https://github.com/orgs/deven-org/projects/3/views/1?pane=info). +- [ ] **Figma** - Everyone with an Accenture email address should be able to view the + [B01LER DS Figma team](https://www.figma.com/files/1248234047942466966/team/1290961933739934842) after joining the + Accenture Global Figma organisation. Select "Use single sign-on" in the login and enter your Accenture-Mail to + join the organisation. For Editing rights or when encountering problems, contact the design lead, design lead + stand-in or the Product & Project Management lead. +- [ ] **Outlook groups** - Access to the + [B01LER Core](https://outlook.office365.com/groups/accenture.com/boiler-core/members) and the + [B01LER](https://outlook.office365.com/groups/accenture.com/boiler-ds/members) Outlook group can be provided by + any of the leads or stand-ins. With the invite, new colleagues will also be added to the B01LER Teams channel. +- [ ] **Slack channels** - All Slack channels are open to join for anyone in the song-asg.slack org and everyone already + on the channels can add new members, to get access to the org, a UHD ticket has to be created. +- [ ] **Mailing lists** - Access to the mailing lists can be provided by the product & project management lead and + stand-in. +- [ ] **Parabol** - Access to [Parabol team](https://action.parabol.co/team/lk4SUDAJz2/) can be provided by the product + & project management lead. ## Project Management Onboarding Checklist + Here is a checklist for project management to follow when onboarding a new colleage. -- [ ] **WBS Authorization** - to book hours on the projects WBS, new colleagues need to be authorized first. Authorization can be requested by the controlling team. -- [ ] **Project forecast** - new colleagues need to be added to the project forecast by the product & project management lead. + +- [ ] **WBS Authorization** - to book hours on the projects WBS, new colleagues need to be authorized first. + Authorization can be requested by the controlling team. +- [ ] **Project forecast** - new colleagues need to be added to the project forecast by the product & project management + lead. - [ ] **Pennyworth** - the product & project management lead needs to add new colleagues to the planning in pennyworth. ## How to get support -For further support you can always reach out to [Thorben Hartmann](https://song-asg.slack.com/team/UDF7P0Y5D) or any of the other team leads via Slack. -Another way is to reach out to our community leaders. Instructions on when and how to contact community leaders can be found in our [Code of Conduct](CODE_OF_CONDUCT.md). + +For further support you can always reach out to [Thorben Hartmann](https://song-asg.slack.com/team/UDF7P0Y5D) or any of +the other team leads via Slack. Another way is to reach out to our community leaders. Instructions on when and how to +contact community leaders can be found in our [Code of Conduct](CODE_OF_CONDUCT.md). ## Link Archive + Here you can find some useful links: -- **[GitHub project](https://github.com/orgs/deven-org/projects/3/views/31?pane=info)** - This is where we are managing our work. Basically it is better view of all the issues in the repository. Here you can find all our boards, our backlogs and our roadmaps. The documentation of all this can be found in the side-panel. -- **[Figma file](https://www.figma.com/file/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=1134-44297&mode=design&t=BFbmHTvPYeKQBmHt-0)** - This is the main Figma file. Here you can find all the component designs and all the design tokens via the Tokens Studio plugin. -- **[README](/README.md)** - In case you have not read the README, you should catch up soon. From here all other documentation. From here the most important files in the `/docs` folder are linked, which you should check out as well. -- **[One Note](https://ts.accenture.com/sites/b01ler-core/Shared%20Documents/Forms/AllItems.aspx?RootFolder=%2Fsites%2Fb01ler%2Dcore%2FShared%20Documents)** - In the B01LER Core One Note you can find meeting notes from regular meetings like planning, refinement and weekly checkups, as well as meeting notes from all other team internal meetings. -- **[Parabol](https://action.parabol.co/team/lk4SUDAJz2/)** - Parabol is used for retrospectives. Here you can see an overview of all actions that were defined in a previous retro. + +- **[GitHub project](https://github.com/orgs/deven-org/projects/3/views/31?pane=info)** - This is where we are managing + our work. Basically it is better view of all the issues in the repository. Here you can find all our boards, our + backlogs and our roadmaps. The documentation of all this can be found in the side-panel. +- **[Figma file](https://www.figma.com/community/file/1354113903886620358/b01ler)** - This is the main Figma file. Here + you can find all the component designs and all the design tokens via the Tokens Studio plugin. +- **[README](/README.md)** - In case you have not read the README, you should catch up soon. From here all other + documentation. From here the most important files in the `/docs` folder are linked, which you should check out as + well. +- **[One Note](https://ts.accenture.com/sites/b01ler-core/Shared%20Documents/Forms/AllItems.aspx?RootFolder=%2Fsites%2Fb01ler%2Dcore%2FShared%20Documents)** - + In the B01LER Core One Note you can find meeting notes from regular meetings like planning, refinement and weekly + checkups, as well as meeting notes from all other team internal meetings. +- **[Parabol](https://action.parabol.co/team/lk4SUDAJz2/)** - Parabol is used for retrospectives. Here you can see an + overview of all actions that were defined in a previous retro.