diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index c1bb55d51..000000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,132 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, pregnancy, maternity, -marital or family status, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -* Focusing on what is best not just for us as individuals, but for the - overall community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or - advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission -* Microaggressions, including subtle yet harmful comments or behaviours that -* contribute to a hostile and discriminatory environment -* Deliberately excluding someone by speaking in a language that they do not -* understand -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -boiler.community@accenture.com. -All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series -of actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within -the community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index c9f9bc227..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,199 +0,0 @@ -# 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! - -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! - - -## :page_with_curl: Content -- [Contributing](#contributing) - - [:page_with_curl: Content](#page_with_curl-content) - - [:new: New contributor guide](#new-new-contributor-guide) - - [:arrows_counterclockwise: Contribution process overview](#arrows_counterclockwise-contribution-process-overview) - - [:rocket: Getting started](#rocket-getting-started) - - [:file_folder: File Structure](#file_folder-file-structure) - - [:clipboard: Issues](#clipboard-issues) - - [Create a new issue](#create-a-new-issue) - - [Solve an existing issue](#solve-an-existing-issue) - - [Tipps to find issues](#tipps-to-find-issues) - - [:arrow_heading_down: Branch](#arrow_heading_down-branch) - - [Branch naming convention](#branch-naming-convention) - - [:handshake: Commits](#handshake-commits) - - [:test_tube: Testing / Validating](#test_tube-testing-and-validating) - - [:arrow_heading_up: Pull Request](#arrow_heading_up-pull-request) - - [: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/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=9020%3A1058&mode=design&t=7cANsYeeqQcDmGpq-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](https://github.com/deven-org/B01LER-Kitchen/blob/develop/README.md). For more details about our Code of Conduct -see [CODE_OF_CONDUCT](https://github.com/deven-org/B01LER-Kitchen/blob/develop/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 -> - 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 (Understand the projects file structure) -2. Create new issue / select an existing issue -3. Create new branch -4. Commit your changes -5. Validate / Run tests -6. Create new pull request -7. Code Review - -## :rocket: Getting started - -Here you can find a quick overview of the whole contribution process, as well as in-depth explanations of each step. - -### :file_folder: File Structure - -Our project has the following file structure: - - └── .github // GitLab CI/CD pipeline - └── .husky // Git hooks configuration files and scripts - └── .vscode // VS code extensions and settings json - └── .yarn // Yarn releases folder - └── doc // The documentation skeleton - └── packages - └── assets // Collection of resources, such as images and other files utilized in B01LER - └── eslint-config-boiler // Specific ESLint configuration for this project - └── figma-design-tokens // Design tokens configuration files and exported token json files - └── icons // Icon configuration files and a collection of icon files in svg format - └── js-example-app // Source code for js testing app for B01LER DS - └── storybook // Configuration files and compiling tools for Storybook - └── ui-library - └── .storybook // Configuration files for Storybook environment, assets, fonts and theme - └── src - └── components // Collection of individual B01LER DS components - └── foundation // Collection of generated token files and component and semantic tokens - └── globals // Exports of constants and types - └── util // Collection of utility or helper functions - └── CODE_OF_CONDUCT.md // Our Code of conduct - └── CONTRIBUTING.md // The file you have open right now - └── LICENCE.md // Software license that governs the use, distribution, and modification of B01LER - └── README.md // Introductory documentation for B01LER - -## :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. - -### Solve an existing issue - -Browse our [existing issues](https://github.com/deven-org/B01LER-Kitchen/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/B01LER-Kitchen/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? -
- -
-
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. - -### Tipps 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 -- 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` - -## :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. - -### 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`). -- **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` - - -## :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'. - -## :test_tube: Testing and validating - -Please, before submitting any contribution, be sure that your branch is passing all the tests. - -```bash -yarn test -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 using the `Development` field in either the -pull request or the issue. - -## :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. diff --git a/README.md b/README.md index 4618faa07..f2d15332d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,7 @@ # B01LER - ![B01LER_UpdateImg_1100-480@2x](https://github.com/deven-org/B01LER-Kitchen/assets/122102805/bae176fa-d423-4353-9805-c4e9e4c29ba1) - ## :page_with_curl: Content - - [B01LER](#b01ler) - [:page_with_curl: Content](#page_with_curl-content) - [:star: Introduction](#star-introduction) @@ -24,11 +21,10 @@ - [Installation](#installation) - [Setup](#setup) - [Usage](#usage) - - [:white\_check\_mark: How to test](#white_check_mark-how-to-test) + - [:white_check_mark: How to test](#white_check_mark-how-to-test) - [:v: Contribute](#v-contribute) - - [:page\_facing\_up: License](#page_facing_up-license) - - [:green\_heart: Code of conduct](#green_heart-code-of-conduct) - + - [:page_facing_up: License](#page_facing_up-license) + - [: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. @@ -52,53 +48,39 @@ Overall, B01LER is a powerful tool that helps you work smarter, not harder. By s #### 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. - ## :art: Resources - [Check out our Figma File](https://www.figma.com/file/zPHgVJFeLAhdM4MdOymhPb/B01LER--%5Bv0.1---alpha-release%5D?type=design&node-id=8941%3A1818&mode=design&t=owVepZzAwdrehnmL-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/boilerds/B01LER-v1-alpha%20release.fig)) - [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/B01LER-Kitchen/discussions). For feature requests please use our [feature request template](https://github.com/deven-org/B01LER-Kitchen/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/B01LER-Kitchen/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](https://github.com/deven-org/B01LER-Kitchen/security/policy) 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/B01LER-Kitchen/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. ## :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). +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). - ## :rocket: How to start - ### Installation -> Note: You need to run terminal as administrator on Windows machines. +> **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 @@ -106,7 +88,7 @@ In addition, you might need to install Corepack. For more information checkout [ $ 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: @@ -134,26 +116,19 @@ In addition, you might need to install Corepack. For more information checkout [ ``` ### Setup -Note: This is not filled out yet! -... +Note: This is not filled out yet! ... ### Usage -Note: This is not filled out yet! -... - +Note: This is not filled out yet! ... ## :white_check_mark: How to test -Learn about our testing approach [here](./doc/TESTING.md). - +Learn about our testing approach [here](./docs/TESTING.md). ## :v: Contribute -For a detailed documentation on how to contribute to the B01LER project, have a look at our [contribution guide](./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](./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/doc/GETSTARTED.md b/doc/GETSTARTED.md deleted file mode 100644 index 574b1b4ad..000000000 --- a/doc/GETSTARTED.md +++ /dev/null @@ -1,108 +0,0 @@ -# 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 newcommer, we've got you covered. Let's dive in and unleash the potential of B01LER together! - -## Content - -- [Team Overview](#team-overview) -- [Regular Meetings](#regular-meetings) -- [Communication Channels](#communication-channels) -- [Access Checklist](#access-checklist) -- [Project Management Checklist](#project-management-checklist) -- [How to get support](#how-to-get-support) -- [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) -- [Jessica Wittig](https://github.com/JpunktWpunkt) -- [Barkley Taylor](https://github.com/bar-tay) -- [Rubiraj Ethirajulu](https://github.com/RubirajAccenture) -- [Ang Sherpa](https://github.com/angsherpa456) -- [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). - -|Meeting Name |When |Who |Why | -|-----------------------------|----------------------------------------------------------------------|----------------------------------------------------------------------|------------------------------------------------------------------------------------| -|B01LER Daily |Wednesdays, Thursdays (beginning of Planning or Refinement) & Fridays |Complete B01LER Team |Updating eachother | -|B01LER Planning |Every 2nd Thursday (When there is no Refinement) |Complete B01LER Team |Celebrate outcome of the last iteration, present outcome of the pre-planning | -|B01LER Refinement |Every 2nd Thursday (When there is no Planning) |Complete B01LER Team |Refining issues for upcomming iterations | -|B01LER Retro |Every 4th Thursday (After Planning) |Complete B01LER Team |Looking back at the last two iterations to improve things in the future | -|B01LER Design Review |Tuesdays & Thursdays |B01LER Design Lead and every team member that needs a design review |Getting approval from design for code implementations | -|B01LER Pair Programming Hour |Fridays |Everyone from the B01LER Team that wants to join |Collaborate and learn from each other by tackling coding challanges together | -|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 |Thursdays |B01LER Leadership (and/or stand-ins) |Discuss and decide on general product topics and check the roadmap | -|B01LER Marketing Weekly |Thursdays |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 | -|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -|Slack |[#boiler-core](https://song-asg.slack.com/archives/C049ZPXBTKJ) |Team internal; Main communication channel, used for general questions, things to share and to inform the team about absences | -|Slack |[#boiler-dev](https://song-asg.slack.com/archives/C0629BCDCSK) |Team internal; Used for dev-topics, that are only affecting devs, like open pull requests or generald technical decisions | -|Slack |[#boiler](https://song-asg.slack.com/archives/C062PQ9DJTD) |External (everyone at Accenture can join); Used for announcements and community building | -|Teams |[B01LER General](https://teams.microsoft.com/l/channel/19%3ABvYMwUq382hbRn7dJyucR3DN4KORS1HjIZl3n5GqE9k1%40thread.tacv2/General?groupId=2d176fa2-6d3a-4c70-a986-d05b5977678f&tenantId=e0793d39-0939-496d-b129-198edd916feb) |External (everyone at Accenture can join); Used for announcements and community building | -|Teams |[B01LER Monthly](https://teams.microsoft.com/l/channel/19%3Aca0a1284d8b34c62b80e983ca3af7934%40thread.tacv2/Monthly%20Session?groupId=2d176fa2-6d3a-4c70-a986-d05b5977678f&tenantId=e0793d39-0939-496d-b129-198edd916feb) |External (everyone at Accenture can join); Used for the B01LER Monthly to share the agenda and meeting notes | -|Mailing List |boiler@accenture.com |Contact Mail for everyone outside of accenture to contact the team, reaches team leaders and stand-ins | -|Mailing List |boiler.community@accenture.com |Contact Mail for everyone outside of accenture to address violations to the code of conduct, reaches community leaders | -|Mailing List |boiler.security@accenture.com |Contact Mail for everyone outside of accenture to report security vulnerabilities, reaches team leaders and dev stand-in lead | -|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** - access to the [B01LER DS Figma team](https://www.figma.com/files/1248234047942466966/team/1290961933739934842) can be provided by the design lead and stand-ins or the product & project 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 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. -- [ ] **Myscheduling** - new colleagues need to be planned in myscheduling by the product & project management lead. -- [ ] **Project forecast** - new colleagues need to be added to the project forecast by the product & project management lead. -- [ ] **Sales Deck Update** - new colleagues need to be added to the contributor overview in the internal sales deck. - - -## 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](https://github.com/deven-org/B01LER-Kitchen/blob/main/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](https://github.com/deven-org/B01LER-Kitchen/blob/main/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 [/doc](https://github.com/deven-org/B01LER-Kitchen/tree/main/doc) 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. diff --git a/doc/ARCHITECTURE.md b/docs/ARCHITECTURE.md similarity index 99% rename from doc/ARCHITECTURE.md rename to docs/ARCHITECTURE.md index 61d981cb0..5c44ca22d 100644 --- a/doc/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -1,9 +1,7 @@ # Architecture - This chapter should provide the user with as mutch information as possible about the architecture and overall structure of your project. Please provide a short introduction here. ## Content - - [Architecture](#architecture) - [Content](#content) - [Overall Structure](#overall-structure) @@ -11,15 +9,12 @@ This chapter should provide the user with as mutch information as possible about - [APIs](#apis) ## Overall Structure - Please explain the overall structure of your project and how everything works together. You can use screenshots or code snippets to help visualize things like e.g. your folder structure or the project setup. In this chapter you can be as detailed as you like. ## Technical Decisions - In this section you should list all technical things you use like frameworks, tools, languages and provide explanations of why you have choosen them. Think about e.g. what are the main reasons you choose a framework, what are the advatages you need for your project? Try to be as clear as possible so also new joiners understand why your setup is the best for your project. ## APIs - Please describe briefly how you manage the APIs of your project and how to use them. The documentation could: diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..160bb53ee --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,79 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, pregnancy, maternity, marital or family status, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards +Examples of behavior that contributes to a positive environment for our community include: +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: +* The use of sexualized language or imagery, and sexual attention or advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, without their explicit permission +* Microaggressions, including subtle yet harmful comments or behaviours that +* contribute to a hostile and discriminatory environment +* Deliberately excluding someone by speaking in a language that they do not +* understand +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. + +## Scope +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at +boiler.community@accenture.com. All complaints will be reviewed and investigated promptly and fairly. +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning +**Community Impact**: A violation through a single incident or series of actions. + +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the community. + +## Attribution +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 000000000..82e7d1a0e --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,111 @@ +# 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! + +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! + +## :page_with_curl: Content +- [Contributing](#contributing) + - [:page_with_curl: Content](#page_with_curl-content) + - [:new: New contributor guide](#new-new-contributor-guide) + - [:arrows_counterclockwise: Contribution process overview](#arrows_counterclockwise-contribution-process-overview) + - [:arrow_right: Getting started](#arrow_right-getting-started) + - [:clipboard: Issues](#clipboard-issues) + - [Create a new issue](#create-a-new-issue) + - [Solve an existing issue](#solve-an-existing-issue) + - [Tips to find issues](#tips-to-find-issues) + - [:arrow_heading_down: Branch](#arrow_heading_down-branch) + - [Branch naming convention](#branch-naming-convention) + - [:handshake: Commits](#handshake-commits) + - [:test_tube: Testing / Validating](#test_tube-testing-and-validating) + - [:arrow_heading_up: Pull Request](#arrow_heading_up-pull-request) + - [: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/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=9020%3A1058&mode=design&t=7cANsYeeqQcDmGpq-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: +- [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 +> - 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 +4. Commit your changes +5. Validate / Run tests +6. Create new pull request +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. + +## :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. + +### Solve an existing issue +Browse our [existing issues](https://github.com/deven-org/B01LER-Kitchen/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/B01LER-Kitchen/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? +
+
    +
  • Use the existing issue templates.
    • +
  • It should be specific. It's important that it addresses one specific topic.
    • +
  • If it is a bug it should be reproducible. It should contain all the instructions needed to reproduce the same outcome.
    • +
  • If the issue is about a component, please add the component name to the beginning of issue title, followed by a dash and a more in detail description of the issue. For example: Text Button - add new variant
    • +
+
+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 +- 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` + +## :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. + +### 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`). +- **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` + +## :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'. + +## :test_tube: Testing and validating +Please, before submitting any contribution, be sure that your branch is passing all the tests. + +```bash +yarn test +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. + +## :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. diff --git a/doc/DEPLOYMENT.md b/docs/DEPLOYMENT.md similarity index 100% rename from doc/DEPLOYMENT.md rename to docs/DEPLOYMENT.md diff --git a/docs/GETSTARTED.md b/docs/GETSTARTED.md new file mode 100644 index 000000000..b6f9776e0 --- /dev/null +++ b/docs/GETSTARTED.md @@ -0,0 +1,90 @@ +# 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! + +## Content +- [Team Overview](#team-overview) +- [Regular Meetings](#regular-meetings) +- [Communication Channels](#communication-channels) +- [Access Checklist](#access-checklist) +- [Project Management Checklist](#project-management-checklist) +- [How to get support](#how-to-get-support) +- [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) +- [Jessica Wittig](https://github.com/JpunktWpunkt) +- [Barkley Taylor](https://github.com/bar-tay) +- [Rubiraj Ethirajulu](https://github.com/RubirajAccenture) +- [Ang Sherpa](https://github.com/angsherpa456) +- [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). + +| Meeting Name | When | Who | Why | +| ---------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| B01LER Daily | Wednesdays, Thursdays (part of Planning and Refinement) & Fridays | Complete B01LER Team | Updating eachother | +| B01LER Planning | Every 2nd Thursday (When there is no Refinement) | Complete B01LER Team | Celebrate outcome of the last iteration, present outcome of the pre-planning | +| B01LER Refinement | Every 2nd Thursday (When there is no Planning) | Complete B01LER Team | Refining issues for upcomming iterations | +| B01LER Retro | Every 4th Thursday (After Planning) | Complete B01LER Team | Looking back at the last two iterations to improve things in the future | +| B01LER Design Review | Tuesdays & Thursdays | B01LER Design Lead and every team member that needs a design review | Getting approval from design for code implementations | +| B01LER Pair Programming Hour | Fridays | Everyone from the B01LER Team that wants to join | Collaborate and learn from each other by tackling coding challanges together | +| 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 | Thursdays | B01LER Leadership (and/or stand-ins) | Discuss and decide on general product topics and check the roadmap | +| B01LER Marketing Weekly | Thursdays | 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 | +| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| Slack | [#boiler-core](https://song-asg.slack.com/archives/C049ZPXBTKJ) | Team internal; Main communication channel, used for general questions, things to share and to inform the team about absences | +| Slack | [#boiler-dev](https://song-asg.slack.com/archives/C0629BCDCSK) | Team internal; Used for dev-topics, that are only affecting devs, like open pull requests or generald technical decisions | +| Slack | [#boiler](https://song-asg.slack.com/archives/C062PQ9DJTD) | External (everyone at Accenture can join); Used for announcements and community building | +| Teams | [B01LER General](https://teams.microsoft.com/l/channel/19%3ABvYMwUq382hbRn7dJyucR3DN4KORS1HjIZl3n5GqE9k1%40thread.tacv2/General?groupId=2d176fa2-6d3a-4c70-a986-d05b5977678f&tenantId=e0793d39-0939-496d-b129-198edd916feb) | External (everyone at Accenture can join); Used for announcements and community building | +| Teams | [B01LER Monthly](https://teams.microsoft.com/l/channel/19%3Aca0a1284d8b34c62b80e983ca3af7934%40thread.tacv2/Monthly%20Session?groupId=2d176fa2-6d3a-4c70-a986-d05b5977678f&tenantId=e0793d39-0939-496d-b129-198edd916feb) | External (everyone at Accenture can join); Used for the B01LER Monthly to share the agenda and meeting notes | +| Mailing List | boiler@accenture.com | Contact Mail for everyone outside of accenture to contact the team, reaches team leaders and stand-ins | +| Mailing List | boiler.community@accenture.com | Contact Mail for everyone outside of accenture to address violations to the code of conduct, reaches community leaders | +| Mailing List | boiler.security@accenture.com | Contact Mail for everyone outside of accenture to report security vulnerabilities, reaches team leaders and dev stand-in lead | +| 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** - access to the [B01LER DS Figma team](https://www.figma.com/files/1248234047942466966/team/1290961933739934842) can be provided by the design lead and stand-ins or the product & project 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 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. +- [ ] **Myscheduling** - new colleagues need to be planned in myscheduling by the product & project management lead. +- [ ] **Project forecast** - new colleagues need to be added to the project forecast by the product & project management lead. +- [ ] **Sales Deck Update** - new colleagues need to be added to the contributor overview in the internal sales deck. + +## 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). + +## 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. diff --git a/doc/GLOSSARY.md b/docs/GLOSSARY.md similarity index 99% rename from doc/GLOSSARY.md rename to docs/GLOSSARY.md index f5e567099..dccc55975 100644 --- a/doc/GLOSSARY.md +++ b/docs/GLOSSARY.md @@ -1,3 +1,2 @@ # Glossary - In this chapter you should start a list of all the project specific terms and their explanations that people new to the project won't know. Also words that people might know but are extremely important, like some technical terms, should be written down here. There can't be too much explanation, so don't heistate to write down all weird words and abbreviations that come to your mind when you think back to your own first days at the project. diff --git a/doc/PROJECTBACKGROUND.md b/docs/PROJECTBACKGROUND.md similarity index 99% rename from doc/PROJECTBACKGROUND.md rename to docs/PROJECTBACKGROUND.md index 1eed3453e..a62ef6e76 100644 --- a/doc/PROJECTBACKGROUND.md +++ b/docs/PROJECTBACKGROUND.md @@ -1,10 +1,7 @@ # Project Background - This chapter provides the users with information about historical decisions, where B01LER started from and what we learned until now. - ## Content - - [Background](#background) - [Strategy](#strategy) - [Design Principles](#design-principles) @@ -12,23 +9,19 @@ This chapter provides the users with information about historical decisions, whe - [Tech Changes](#tech-changes) ## Background - The idea for a boilerplate design system formed in 2022 during a client project which included the creation of a new design system. The main goal was to find a way to reduce reduncancies when creating components. Lars Erbach and Marcel Doering teamed up and prepared an elevator pitch for the leadership. After this the leadership agreed to to invest some time for team to come up with a real business case and a final presentation until end of November 2022. For this Thorben Hartmann also joined the team. The resulting presentation can be found [here](https://www.figma.com/file/A3qtxWTli1tQpgIK9wAjBO/%F0%9F%8E%A8-B01LER-Pitch-Convolute-%5BTEMPLATES%5D-(Copy)?type=design&node-id=192%3A3244&mode=design&t=FiW9ptIXH0xYtE1x-1) (you need to be part of the Accenture org in Figma). The feedback was very overwhelmingly positive and the leadership directly made plans to allocate some budget for 2023 to build B01LER. Early 2023 the budget to build B01LER was approved. Lars TΓΆppner and Oliver Klee joined the team as developers and the team started with the setup. In early March, a first Milestone was reached with the finalization of the first component: the Text Button (https://github.com/deven-org/B01LER-Kitchen/issues/50). The team was on track to finish the initial set of components in the defined time, but unfortunatley Lars TΓΆppner and a month later Oliver were needed on other projects and had to leave the team. Finding substitutes turned out to be harder than expected, before Christian Hoffman and David Kennedy took over the role of dev leads and brought back some stability to the team. To make up time that was lost during the staffing changes, the team size was extended and other developers and designers also joined the team, at one time reaching even 12 members. In autumn 2023 another huge milestone was reached with the finalization of the initial set of [15 components](https://github.com/deven-org/B01LER-Kitchen/milestone/1). It took a few more months though to finalise the first release, as some of the first components as well as some general topics needed some refactoring first. The first release went live on 16.12.2023 together with the B01LER website [boilerds.com](https://boilerds.com). Together with the first release, the repository and the Figma file were also published under open source licences (see also the milestones [Alpha Release](https://github.com/deven-org/B01LER-Kitchen/milestone/15), [Release Figma File](https://github.com/deven-org/B01LER-Kitchen/milestone/11) and [Make Repository Public](https://github.com/deven-org/B01LER-Kitchen/milestone/12)). - ## Strategy - To understand the product strategy of B01LER you should have a look at our [Sales Deck](https://ts.accenture.com/:p:/r/sites/SongBuildNewBiz/Shared%20Documents/Credentials%20and%20Capabilities/B01LER%20(Design%20System)/B01LER_SalesDeck.pptx?d=w542967209a6942448f4de4eec58007c1&csf=1&web=1&e=hgHVRx) (you need to be part of the Accenture org to access). To understand how we as a team work you should read the next two sections. ### Design Principles One outcome of the early phase of B01LER wich still is relevant to how we work and solve issues are our design principles. They can be found in [this Figma presentaton](https://www.figma.com/file/XaypOKpd17gJ7Y8S2DcWXv/%F0%9F%94%A5-DSO-%23FFF?type=design&node-id=37%3A1370&mode=design&t=ZWzlGCuxdhB8bn8D-1), or you can read through them here: - 1. **It’s wrong if it ain’t fun** - To be clear, we like challenges and want to grow by them. We do what needs to be done and of course some things are less fun than others. But: We will keep our north star and not commit to things we do not believe in. Ultimately, this benefits every single person that works with us. 2. **Show, don’t tell** - We do not want to talk all day and tell everyone what greatness is ahead. We will explain our ways of working by doing and showing. This is not limited to any field. Thus, we let people experience what they are buying from us. 3. **Nothing is set in stone** - Everything evolves. Required skills & knowledge, demands from our clients, user expectations and much more. We’re good, but not godsβ€”β€”and we for sure plan on never losing that Oh! πŸ’‘ This allows us to react to changes, adopt the new and keep on improving. @@ -54,9 +47,5 @@ Rules and principles we are not following anymore: - Initially we also started estimating issues to get a better feeling how much we can get done in one iteration, but this was only slowing us down and did not bring the benefit we thought it would; also we are no longer only working on issues that have been estimated before - We moved from defining tasks small enough that they can be finished in a comprehensible time-frame but also big enough to minimise overhead to defining tasks generally smaller so they can also be understood easier by juniors or external contributors - - - ## Tech Changes - - We decided end of 2023 / beginning of 2024 to switch from npm to yarn pnp to reduce build time, with quite some success. diff --git a/SECURITY.md b/docs/SECURITY.md similarity index 99% rename from SECURITY.md rename to docs/SECURITY.md index 5609a98a8..bc0178d51 100644 --- a/SECURITY.md +++ b/docs/SECURITY.md @@ -1,11 +1,8 @@ # Security Policy - ## Supported Versions - Security updates are only applied to the latest published version. ## Reporting a Vulnerability - Please do not disclose security vulnerabilities in public issues, disclosures, or pull requests. Instead, please send an email to [boiler.security@accenture.com](mailto:boiler.security@accenture.com). diff --git a/doc/SUPPORT.md b/docs/SUPPORT.md similarity index 88% rename from doc/SUPPORT.md rename to docs/SUPPORT.md index 6b9cc98c9..58785fe7e 100644 --- a/doc/SUPPORT.md +++ b/docs/SUPPORT.md @@ -1,13 +1,8 @@ # Support - ## Browsers - -B01LER aims to support the latest two major versions of evergreen-browsers at the time of -each release. - +B01LER aims to support the latest two major versions of evergreen-browsers at the time of each release. ## FAQ - In case your question is not listed here, please ask the question by starting a discussion [here](https://github.com/deven-org/B01LER-Kitchen/discussions). Currently there are no FAQs yet. This will change as soon as we answered some questions. diff --git a/doc/TESTING.md b/docs/TESTING.md similarity index 81% rename from doc/TESTING.md rename to docs/TESTING.md index d929c3a20..5392ac4dd 100644 --- a/doc/TESTING.md +++ b/docs/TESTING.md @@ -7,10 +7,10 @@ This chapter provides the user with all needed information around testing within - [Different kind of tests](#different-kind-of-tests) - [Testing strategy](#testing-strategy) - [Tooling](#tooling) - - [open-wc-testing](#open-wc-testing) + - [open-wc-testing](#open-wc-testing) - [How to write tests](#how-to-write-tests) - - [Directory structure](#directory-structure) - - [Examples](#examples) + - [Directory structure](#directory-structure) + - [Examples](#examples) - [How to run tests](#how-to-run-tests) - [Contributing](#contributing) @@ -24,14 +24,12 @@ The tests are crafted to validate the functionality of the software, ensuring it ## Tooling ### open-wc-testing -This repository contains tests written using the `@open-wc/testing` library. `@open-wc/testing` provides a suite of -tools and utilities for testing web components, following modern best practices and standards. +This repository contains tests written using the `@open-wc/testing` library. `@open-wc/testing` provides a suite of tools and utilities for testing web components, following modern best practices and standards. [Read more here](https://open-wc.org/docs/testing/testing-package/). ## How to write tests To write tests using `@open-wc/testing`, follow these steps: - 1. Import the necessary functions and utilities from `@open-wc/testing`. 2. Write your test cases using the provided utilities such as `fixture`, `html`, `litFixture`, etc. @@ -58,7 +56,6 @@ describe('MyComponent', () => { ## How to run tests Local Setup: - ```sh 1. Clone this repository to your local machine. 2. Navigate to the project directory in your terminal. @@ -67,10 +64,9 @@ Local Setup: ``` The project test suite is run with - ```sh $ yarn run test ``` ## Contributing -Contributions are welcome! Before opening a [bug report](https://github.com/deven-org/B01LER-Kitchen/issues/new?assignees=&labels=%F0%9F%9A%A8+new%3A%3Abug&projects=deven-org%2F3&template=1_bug_report.yaml&title=%5BBug%5D%3A+) or a [feature request](https://github.com/deven-org/B01LER-Kitchen/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+) please check out our [contribution guide](https://github.com/deven-org/B01LER-Kitchen/blob/main/doc/CONTRIBUTE.md) and our [code of conduct](https://github.com/deven-org/B01LER-Kitchen/blob/main/CODE_OF_CONDUCT.md). In case you discover a security vulnerability please review our [security policy](https://github.com/deven-org/B01LER-Kitchen/security/policy) for more details on how to report it. +Contributions are welcome! Before opening a [bug report](https://github.com/deven-org/B01LER-Kitchen/issues/new?assignees=&labels=%F0%9F%9A%A8+new%3A%3Abug&projects=deven-org%2F3&template=1_bug_report.yaml&title=%5BBug%5D%3A+) or a [feature request](https://github.com/deven-org/B01LER-Kitchen/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+) please check out our [contribution guide](CONTRIBUTING.md) and our [code of conduct](CODE_OF_CONDUCT.md). In case you discover a security vulnerability please review our [security policy](SECURITY.md) for more details on how to report it.