From 058ca98b50e6b6d085da854af68c67122d7189b7 Mon Sep 17 00:00:00 2001 From: k3ii Date: Sun, 25 Aug 2024 13:24:19 +0400 Subject: [PATCH 1/7] docs: create new dir info docs(info): add how to become speaker --- .../content/{ => info}/history.md | 0 .../content/info/how-to-become-a-speaker.md | 60 +++++++++++++++++++ .../content/{ => info}/how-to-contribute.md | 0 3 files changed, 60 insertions(+) rename packages/frontendmu-nuxt/content/{ => info}/history.md (100%) create mode 100644 packages/frontendmu-nuxt/content/info/how-to-become-a-speaker.md rename packages/frontendmu-nuxt/content/{ => info}/how-to-contribute.md (100%) diff --git a/packages/frontendmu-nuxt/content/history.md b/packages/frontendmu-nuxt/content/info/history.md similarity index 100% rename from packages/frontendmu-nuxt/content/history.md rename to packages/frontendmu-nuxt/content/info/history.md diff --git a/packages/frontendmu-nuxt/content/info/how-to-become-a-speaker.md b/packages/frontendmu-nuxt/content/info/how-to-become-a-speaker.md new file mode 100644 index 00000000..e0ca6ad9 --- /dev/null +++ b/packages/frontendmu-nuxt/content/info/how-to-become-a-speaker.md @@ -0,0 +1,60 @@ +# Become a Speaker at Our Frontend Community + +Are you passionate about frontend development, or do you have insights into related areas like +devtools, backend, or full-stack development? Becoming a speaker at our frontend community +events is a great way to contribute, gain recognition, and grow your professional network. + +## Why Speak at Our Events? + +* Share Your Knowledge: Whether you're an expert or just starting out, your unique experiences and insights can provide valuable perspectives to others in the community. +* Build Your Network: Speaking at our events connects you with fellow developers, industry professionals, and potential collaborators. +* Enhance Your Profile: Public speaking is a great way to build your personal brand, demonstrate expertise, and increase visibility within the tech community. +* Improve Your Skills: Public speaking helps you improve your communication skills, gain confidence, and learn to present complex ideas in an accessible way. + +## Who Can Apply? + +Anyone with a passion for technology is welcome to apply. We encourage speakers of all +backgrounds, experiences, and expertise levels to share their knowledge. Whether you're an +experienced developer, a designer, or a beginner who has discovered something new, +we'd love to hear from you. + +## What Can You Talk About? + +Our community values diversity in topics. While we focus on frontend development, we're also interested in talks that cover a broad range of related areas. Here are some ideas to inspire you: + +* Frontend Frameworks & Libraries: Share your experience with popular tools like React, Vue, Nuxt, or Astro, etc. +* Design Systems & UX: Talk about designing for accessibility, creating intuitive user interfaces, or developing design systems. +* Web Performance: Discuss strategies for optimizing performance, reducing load times, or improving user experience. +* CSS & Styling Techniques: Present advanced CSS techniques, responsive design practices, or how to use modern styling tools. +* JavaScript Tips & Tricks: Share your knowledge on ES6+ features, async programming, or debugging techniques. +* DevTools & Workflow Optimization: Discuss your favorite tools for speeding up development or debugging complex issues. +* Backend & APIs: Explore how the backend interacts with frontend, or share best practices for building robust APIs. + +## How to Apply + +1. Choose Your Topic: + +Decide on a topic that you are passionate about and that would interest our community. +Make sure it’s something you can confidently speak about for 20–45 minutes. + +2. Submit Your Proposal: + +Reach out to us on our socials with a brief description of your talk. + +3. Prepare Your Talk: + +You'll have plenty of time to prepare your talk. We also do practice runs and provide feedback to help you refine your presentation. +The practice runs are usually done on a Thursday on [cedpoilly Discord server](https://discord.gg/M2VRY39A) before the event. + +## Tips for First-Time Speakers + +Tips for First-Time Speakers + +* Start Small: If you're new to public speaking, consider doing a lightning talk (5-10 minutes) as a way to ease into it. +* Practice: Rehearse your talk multiple times. Practice in front of a friend or record yourself to identify areas for improvement. +* Engage with the Audience: Encourage questions and be open to feedback. Engaging with the audience makes your talk more interactive and memorable. +* Be Yourself: Authenticity resonates with the audience. Don’t try to imitate someone else’s style—just be yourself. + +Ready to Inspire? + +We’re excited to hear from you! Apply now to become a speaker at our next frontend community event and share your passion with others. diff --git a/packages/frontendmu-nuxt/content/how-to-contribute.md b/packages/frontendmu-nuxt/content/info/how-to-contribute.md similarity index 100% rename from packages/frontendmu-nuxt/content/how-to-contribute.md rename to packages/frontendmu-nuxt/content/info/how-to-contribute.md From 473ff38024bad66239353a2e6144e2712c505a32 Mon Sep 17 00:00:00 2001 From: k3ii Date: Sun, 25 Aug 2024 13:38:43 +0400 Subject: [PATCH 2/7] fix(content): move files to contents --- packages/frontendmu-nuxt/content/{info => }/history.md | 0 .../frontendmu-nuxt/content/{info => }/how-to-become-a-speaker.md | 0 packages/frontendmu-nuxt/content/{info => }/how-to-contribute.md | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename packages/frontendmu-nuxt/content/{info => }/history.md (100%) rename packages/frontendmu-nuxt/content/{info => }/how-to-become-a-speaker.md (100%) rename packages/frontendmu-nuxt/content/{info => }/how-to-contribute.md (100%) diff --git a/packages/frontendmu-nuxt/content/info/history.md b/packages/frontendmu-nuxt/content/history.md similarity index 100% rename from packages/frontendmu-nuxt/content/info/history.md rename to packages/frontendmu-nuxt/content/history.md diff --git a/packages/frontendmu-nuxt/content/info/how-to-become-a-speaker.md b/packages/frontendmu-nuxt/content/how-to-become-a-speaker.md similarity index 100% rename from packages/frontendmu-nuxt/content/info/how-to-become-a-speaker.md rename to packages/frontendmu-nuxt/content/how-to-become-a-speaker.md diff --git a/packages/frontendmu-nuxt/content/info/how-to-contribute.md b/packages/frontendmu-nuxt/content/how-to-contribute.md similarity index 100% rename from packages/frontendmu-nuxt/content/info/how-to-contribute.md rename to packages/frontendmu-nuxt/content/how-to-contribute.md From 3cf9382e5f618c2da128e90bafb153674c1c4902 Mon Sep 17 00:00:00 2001 From: k3ii Date: Sun, 25 Aug 2024 13:43:44 +0400 Subject: [PATCH 3/7] fix(content): update how-to-become-a-speaker.md --- .../frontendmu-nuxt/content/how-to-become-a-speaker.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/packages/frontendmu-nuxt/content/how-to-become-a-speaker.md b/packages/frontendmu-nuxt/content/how-to-become-a-speaker.md index e0ca6ad9..983a98d4 100644 --- a/packages/frontendmu-nuxt/content/how-to-become-a-speaker.md +++ b/packages/frontendmu-nuxt/content/how-to-become-a-speaker.md @@ -1,5 +1,4 @@ # Become a Speaker at Our Frontend Community - Are you passionate about frontend development, or do you have insights into related areas like devtools, backend, or full-stack development? Becoming a speaker at our frontend community events is a great way to contribute, gain recognition, and grow your professional network. @@ -41,20 +40,20 @@ Make sure it’s something you can confidently speak about for 20–45 minutes. Reach out to us on our socials with a brief description of your talk. -3. Prepare Your Talk: +3. Practice runs: -You'll have plenty of time to prepare your talk. We also do practice runs and provide feedback to help you refine your presentation. +We do practice runs and provide feedback to help you refine your presentation. The practice runs are usually done on a Thursday on [cedpoilly Discord server](https://discord.gg/M2VRY39A) before the event. ## Tips for First-Time Speakers Tips for First-Time Speakers -* Start Small: If you're new to public speaking, consider doing a lightning talk (5-10 minutes) as a way to ease into it. +* Start Small: If you're new to public speaking, consider doing a topic you know well and comfortable with as a way to ease into it. * Practice: Rehearse your talk multiple times. Practice in front of a friend or record yourself to identify areas for improvement. * Engage with the Audience: Encourage questions and be open to feedback. Engaging with the audience makes your talk more interactive and memorable. * Be Yourself: Authenticity resonates with the audience. Don’t try to imitate someone else’s style—just be yourself. -Ready to Inspire? +## Ready to Inspire? We’re excited to hear from you! Apply now to become a speaker at our next frontend community event and share your passion with others. From 3c226770ec7e4784199d918b805fa44be6fc6cac Mon Sep 17 00:00:00 2001 From: k3ii Date: Sun, 25 Aug 2024 14:39:37 +0400 Subject: [PATCH 4/7] fix(nuxt): add contribute to Menu --- packages/frontendmu-nuxt/components/site/Menu.vue | 5 +++++ .../content/{how-to-contribute.md => contribute.md} | 0 2 files changed, 5 insertions(+) rename packages/frontendmu-nuxt/content/{how-to-contribute.md => contribute.md} (100%) diff --git a/packages/frontendmu-nuxt/components/site/Menu.vue b/packages/frontendmu-nuxt/components/site/Menu.vue index 1a721643..65d4e1a3 100644 --- a/packages/frontendmu-nuxt/components/site/Menu.vue +++ b/packages/frontendmu-nuxt/components/site/Menu.vue @@ -32,6 +32,11 @@ const links: TMenu = { href: '/history', class: '', }, + { + title: 'Contribute', + href: '/contribute', + class: '', + }, { title: 'WhatsApp', href: 'https://chat.whatsapp.com/invite/0kQ2QX0ZQ0j1YQ4X6Q4Q4Q', diff --git a/packages/frontendmu-nuxt/content/how-to-contribute.md b/packages/frontendmu-nuxt/content/contribute.md similarity index 100% rename from packages/frontendmu-nuxt/content/how-to-contribute.md rename to packages/frontendmu-nuxt/content/contribute.md From 26c964ad2201bc0aeacaaaa91cbfee56d152e9e0 Mon Sep 17 00:00:00 2001 From: k3ii Date: Sun, 25 Aug 2024 23:54:05 +0400 Subject: [PATCH 5/7] fix(content): add missing md files --- .../content/CODE_OF_CONDUCT.md | 78 +++++++++++++++++++ .../content/CODING_GUIDELINES.md | 61 +++++++++++++++ 2 files changed, 139 insertions(+) create mode 100644 packages/frontendmu-nuxt/content/CODE_OF_CONDUCT.md create mode 100644 packages/frontendmu-nuxt/content/CODING_GUIDELINES.md diff --git a/packages/frontendmu-nuxt/content/CODE_OF_CONDUCT.md b/packages/frontendmu-nuxt/content/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..8b6fde6c --- /dev/null +++ b/packages/frontendmu-nuxt/content/CODE_OF_CONDUCT.md @@ -0,0 +1,78 @@ +# Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in the Frontend.mu community a harassment-free experience for everyone. + +## 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 +- 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 with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and it 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 [INSERT CONTACT EMAIL]. 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](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html). + +Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity). + +For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). + +[homepage]: https://www.contributor-covenant.org + diff --git a/packages/frontendmu-nuxt/content/CODING_GUIDELINES.md b/packages/frontendmu-nuxt/content/CODING_GUIDELINES.md new file mode 100644 index 00000000..ca0a10d2 --- /dev/null +++ b/packages/frontendmu-nuxt/content/CODING_GUIDELINES.md @@ -0,0 +1,61 @@ +# Coding Guidelines + +To maintain code quality and consistency across the Frontend.mu project, please adhere to the following guidelines: +However,These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. + +## 1. General Principles + +- **Clarity and Simplicity:** Write clear and straightforward code. Avoid complex or obscure constructs. +- **Consistency:** Follow the existing code patterns and project structure. Consistency is key to maintainability. + +## 2. Language and Frameworks + + PLEASE ADD GUIDELINES + +## 3. File and Folder Structure + + PLEASE ADD GUIDELINES + +## 4. Code Formatting + + PLEASE ADD GUIDELINES + +## 5. Commit Messages + +- **Format:** Follow the convention: `type(scope): description`. For example, `fix(navbar): resolve alignment issue`. +- **Types:** Use types like `feat`, `fix`, `docs`, `style`, `refactor`, `test`, and `chore`. +- **Detail:** Provide enough context in the description to explain why the change was made. + +## 6. Documentation + + PLEASE ADD GUIDELINES + +## 7. Testing + + PLEASE ADD GUIDELINES + +## 8. Accessibility + +- **ARIA:** Use ARIA attributes where necessary to improve accessibility. +- **Keyboard Navigation:** Ensure that all interactive elements are keyboard-accessible. +- **Contrast and Readability:** Follow WCAG guidelines for contrast and readability. + +## 9. Pull Requests + +- **Review:** Before submitting a pull request, review your code and ensure it meets these guidelines. +- **Testing:** Run all tests and linters. Ensure everything passes. +- **Description:** Provide a clear and concise description of what your PR does and why. + +## 10. Code Reviews + +- **Constructive Feedback:** Provide constructive feedback that is clear and actionable. +- **Respect:** Respect the original author's approach but suggest improvements when necessary. +- **Responsibility:** Reviewers should feel responsible for the quality and maintainability of the codebase. + +## 11. Dependencies + +- **Updates:** Keep dependencies up-to-date, especially for security patches. +- **Minimalism:** Avoid adding unnecessary dependencies. Justify the need for each new dependency in your PR. + +Thank you for contributing to Frontend.mu! Following these guidelines helps us maintain a high standard of quality and consistency. + From 401a50ce2044359aad88d34a0aa2dd64f5b03230 Mon Sep 17 00:00:00 2001 From: k3ii Date: Mon, 26 Aug 2024 00:02:21 +0400 Subject: [PATCH 6/7] feat(menu): add code-of-conduct and coding guidelines --- packages/frontendmu-nuxt/components/site/Menu.vue | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/packages/frontendmu-nuxt/components/site/Menu.vue b/packages/frontendmu-nuxt/components/site/Menu.vue index 65d4e1a3..54f6d92f 100644 --- a/packages/frontendmu-nuxt/components/site/Menu.vue +++ b/packages/frontendmu-nuxt/components/site/Menu.vue @@ -37,6 +37,16 @@ const links: TMenu = { href: '/contribute', class: '', }, + { + title: 'CODE OF CONDUCT', + href: '/code_of_conduct', + class: '', + }, + { + title: 'Coding Guidelines', + href: '/coding_guidelines', + class: '', + }, { title: 'WhatsApp', href: 'https://chat.whatsapp.com/invite/0kQ2QX0ZQ0j1YQ4X6Q4Q4Q', From 3e200d23bacedc7e056bae5651cc8638a7324098 Mon Sep 17 00:00:00 2001 From: k3ii Date: Mon, 26 Aug 2024 00:06:48 +0400 Subject: [PATCH 7/7] chore(menu): Making CODE OF CONDUCT stop yelling --- packages/frontendmu-nuxt/components/site/Menu.vue | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/frontendmu-nuxt/components/site/Menu.vue b/packages/frontendmu-nuxt/components/site/Menu.vue index 54f6d92f..cba054ab 100644 --- a/packages/frontendmu-nuxt/components/site/Menu.vue +++ b/packages/frontendmu-nuxt/components/site/Menu.vue @@ -38,7 +38,7 @@ const links: TMenu = { class: '', }, { - title: 'CODE OF CONDUCT', + title: 'Code of conduct', href: '/code_of_conduct', class: '', },