diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..8b6fde6c --- /dev/null +++ b/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/CODING_GUIDELINES.md b/CODING_GUIDELINES.md new file mode 100644 index 00000000..ca0a10d2 --- /dev/null +++ b/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. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..cd6c5af0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,64 @@ + +# Contributing to frontend.mu + +Thank you for your interest in contributing to Frontend.mu! 🎉 +Our community-driven platform thrives on contributions from members like you, whether you're helping +to organize events, enhancing the website, or simply sharing knowledge. + + +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [Ways to Contribute](#ways-to-contribute) +- [Running the Project Locally](#running-the-project-locally) +- [Submitting Contributions](#submitting-contributions) +- [Reporting Issues and Suggestions](#reporting-issues-and-suggestions) +- [Code Style and Guidelines](#code-style-and-guidelines) +- [Acknowledgements](#acknowledgements) + +## Code of Conduct + +Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a welcoming and inclusive environment for everyone. + +## Ways to Contribute + +There are many ways you can contribute to Frontend.mu: + +- **Event Organization:** Help us plan, promote, and run meetups. You can propose topics, suggest speakers, or volunteer to help with logistics. +- **Design and Frontend Development:** Improve the look and feel of our website. Whether it's updating the UI, enhancing accessibility, or fixing bugs, your skills are invaluable. +- **Speaker and Sponsor Management:** Assist in managing the list of speakers and sponsors, ensuring that information is up-to-date and accurately represented. +- **Community Engagement:** Help us grow the community by spreading the word, engaging with attendees, and fostering discussions online and offline. + +## Running the Project Locally + +1. **Fork the Repository:** Start by forking the repository to create your own copy on GitHub. +2. **Clone Your Fork:** Clone your forked repository to your local machine. +3. **Open the Project:** Navigate to the cloned `frontend.mu` directory in your code editor. +4. **Install Dependencies:** Run `pnpm install` to install the required packages. +5. **Set Up Environment Variables:** Copy `.env.example` to `.env.development`: + ```bash + cp .env.example .env.development + ``` +5. **Start the Development Server:** Use `pnpm run nuxt dev` to launch the project locally. + +## Submitting Contributions + +1. **Commit & Push:** Commit your changes and push them to your forked repository. +2. **Open a Pull Request:** Head to your fork on GitHub, click on the `Contribute` button, and then `Open a pull request` to submit your changes. + +## Reporting Issues and Suggestions + +If you encounter any issues or have ideas for improvements, please open an issue on GitHub. +Provide as much detail as possible, including screenshots or logs if applicable. + +## Code Style and Guidelines + +- Follow our [coding standards](CODING_GUIDELINES.md). +- Ensure your code is well-documented and tested. +- Use clear and concise commit messages. +- Adhere to accessibility best practices. + +## Acknowledgements + +Thank you for being a part of Frontend.mu! Your contributions help us build a stronger community and better resources for frontend developers in Mauritius. +If you have any questions, feel free to reach out to us via GitHub issues, Discord or at our next meetup! diff --git a/README.md b/README.md index dbf71901..e02ba97c 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,19 @@ Front-End coders Mauritius is a free meetup that's dedicated to all aspect of Front-End development. it occurs in general one a month at announced date and place. Feel free to join! -Live website : https://frontend.mu/ +Live website : [https://frontend.mu/](https://frontend.mu/) -## Setup +## Getting Started + +### Prerequisites [Install pnpm](https://pnpm.io/installation) on your development environment for the best experience. +### Dependencies + +Use pnpm to install the dependencies. + + ``` pnpm install ``` @@ -20,30 +27,19 @@ To run the astro project, run the following command pnpm run astro dev ``` -## Environment variables +### Environment variables Make a copy of .env.example and rename it to .env.development on your local machine. -If not, the application will fail to start ``` cp .env.example .env.development ``` +If you don't do this, the application will fail to start -## Feel free to contribute :D - -### Run the project locally - -1. Fork the repository to get your copy on your account. -2. Clone your forked repository on your machine. -3. Open the cloned `frontend.mu` directory in your code editor. -4. Run `pnpm install` in your terminal. -5. Run `pnpm run nuxt dev`. - -### Submit your PR +## Contributing +We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) file for details on how to get started, submit PRs, and more. -1. Commit & push your changes on your forked repository. -2. Log in to your GitHub account & go to your forked repository's page. -3. On the `Code` tab, click `Contribute` and then `Open a pull request` to submit your PR ([read more about this](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project#making-a-pull-request)). +## Community +Join our community on [Discord](https://discord.gg/WxXW9Jvv6k?ref=frontend.mu) if you have any questions or need assistance. We're here to help! -**Chat with us on [Discord](https://discord.gg/WxXW9Jvv6k?ref=frontend.mu) if you're having any issue! ✌️** \ No newline at end of file