Skip to content

Commit ae5809d

Browse files
MrSunshyneMrSunshyne
authored
Merge pull request #177 from k3ii/Contributing
Enhance project documentation
2 parents b2e2939 + 370f819 commit ae5809d

File tree

4 files changed

+218
-19
lines changed

4 files changed

+218
-19
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in the Frontend.mu community a harassment-free experience for everyone.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to a positive environment for our community include:
10+
11+
- Demonstrating empathy and kindness toward other people
12+
- Being respectful of differing opinions, viewpoints, and experiences
13+
- Giving and gracefully accepting constructive feedback
14+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
15+
- Focusing on what is best not just for us as individuals, but for the overall community
16+
17+
Examples of unacceptable behavior include:
18+
19+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
20+
- Trolling, insulting or derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others’ private information, such as a physical or email address, without their explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Enforcement Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
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.
34+
35+
## Enforcement
36+
37+
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.
38+
39+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
40+
41+
## Enforcement Guidelines
42+
43+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
44+
45+
### 1. Correction
46+
47+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
48+
49+
**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.
50+
51+
### 2. Warning
52+
53+
**Community Impact**: A violation through a single incident or series of actions.
54+
55+
**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.
56+
57+
### 3. Temporary Ban
58+
59+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
60+
61+
**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.
62+
63+
### 4. Permanent Ban
64+
65+
**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.
66+
67+
**Consequence**: A permanent ban from any sort of public interaction within the community.
68+
69+
## Attribution
70+
71+
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).
72+
73+
Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).
74+
75+
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).
76+
77+
[homepage]: https://www.contributor-covenant.org
78+

‎CODING_GUIDELINES.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Coding Guidelines
2+
3+
To maintain code quality and consistency across the Frontend.mu project, please adhere to the following guidelines:
4+
However,These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
5+
6+
## 1. General Principles
7+
8+
- **Clarity and Simplicity:** Write clear and straightforward code. Avoid complex or obscure constructs.
9+
- **Consistency:** Follow the existing code patterns and project structure. Consistency is key to maintainability.
10+
11+
## 2. Language and Frameworks
12+
13+
PLEASE ADD GUIDELINES
14+
15+
## 3. File and Folder Structure
16+
17+
PLEASE ADD GUIDELINES
18+
19+
## 4. Code Formatting
20+
21+
PLEASE ADD GUIDELINES
22+
23+
## 5. Commit Messages
24+
25+
- **Format:** Follow the convention: `type(scope): description`. For example, `fix(navbar): resolve alignment issue`.
26+
- **Types:** Use types like `feat`, `fix`, `docs`, `style`, `refactor`, `test`, and `chore`.
27+
- **Detail:** Provide enough context in the description to explain why the change was made.
28+
29+
## 6. Documentation
30+
31+
PLEASE ADD GUIDELINES
32+
33+
## 7. Testing
34+
35+
PLEASE ADD GUIDELINES
36+
37+
## 8. Accessibility
38+
39+
- **ARIA:** Use ARIA attributes where necessary to improve accessibility.
40+
- **Keyboard Navigation:** Ensure that all interactive elements are keyboard-accessible.
41+
- **Contrast and Readability:** Follow WCAG guidelines for contrast and readability.
42+
43+
## 9. Pull Requests
44+
45+
- **Review:** Before submitting a pull request, review your code and ensure it meets these guidelines.
46+
- **Testing:** Run all tests and linters. Ensure everything passes.
47+
- **Description:** Provide a clear and concise description of what your PR does and why.
48+
49+
## 10. Code Reviews
50+
51+
- **Constructive Feedback:** Provide constructive feedback that is clear and actionable.
52+
- **Respect:** Respect the original author's approach but suggest improvements when necessary.
53+
- **Responsibility:** Reviewers should feel responsible for the quality and maintainability of the codebase.
54+
55+
## 11. Dependencies
56+
57+
- **Updates:** Keep dependencies up-to-date, especially for security patches.
58+
- **Minimalism:** Avoid adding unnecessary dependencies. Justify the need for each new dependency in your PR.
59+
60+
Thank you for contributing to Frontend.mu! Following these guidelines helps us maintain a high standard of quality and consistency.
61+

‎CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<!-- omit in toc -->
2+
# Contributing to frontend.mu
3+
4+
Thank you for your interest in contributing to Frontend.mu! 🎉
5+
Our community-driven platform thrives on contributions from members like you, whether you're helping
6+
to organize events, enhancing the website, or simply sharing knowledge.
7+
8+
<!-- omit in toc -->
9+
## Table of Contents
10+
11+
- [Code of Conduct](#code-of-conduct)
12+
- [Ways to Contribute](#ways-to-contribute)
13+
- [Running the Project Locally](#running-the-project-locally)
14+
- [Submitting Contributions](#submitting-contributions)
15+
- [Reporting Issues and Suggestions](#reporting-issues-and-suggestions)
16+
- [Code Style and Guidelines](#code-style-and-guidelines)
17+
- [Acknowledgements](#acknowledgements)
18+
19+
## Code of Conduct
20+
21+
Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a welcoming and inclusive environment for everyone.
22+
23+
## Ways to Contribute
24+
25+
There are many ways you can contribute to Frontend.mu:
26+
27+
- **Event Organization:** Help us plan, promote, and run meetups. You can propose topics, suggest speakers, or volunteer to help with logistics.
28+
- **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.
29+
- **Speaker and Sponsor Management:** Assist in managing the list of speakers and sponsors, ensuring that information is up-to-date and accurately represented.
30+
- **Community Engagement:** Help us grow the community by spreading the word, engaging with attendees, and fostering discussions online and offline.
31+
32+
## Running the Project Locally
33+
34+
1. **Fork the Repository:** Start by forking the repository to create your own copy on GitHub.
35+
2. **Clone Your Fork:** Clone your forked repository to your local machine.
36+
3. **Open the Project:** Navigate to the cloned `frontend.mu` directory in your code editor.
37+
4. **Install Dependencies:** Run `pnpm install` to install the required packages.
38+
5. **Set Up Environment Variables:** Copy `.env.example` to `.env.development`:
39+
```bash
40+
cp .env.example .env.development
41+
```
42+
5. **Start the Development Server:** Use `pnpm run nuxt dev` to launch the project locally.
43+
44+
## Submitting Contributions
45+
46+
1. **Commit & Push:** Commit your changes and push them to your forked repository.
47+
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.
48+
49+
## Reporting Issues and Suggestions
50+
51+
If you encounter any issues or have ideas for improvements, please open an issue on GitHub.
52+
Provide as much detail as possible, including screenshots or logs if applicable.
53+
54+
## Code Style and Guidelines
55+
56+
- Follow our [coding standards](CODING_GUIDELINES.md).
57+
- Ensure your code is well-documented and tested.
58+
- Use clear and concise commit messages.
59+
- Adhere to accessibility best practices.
60+
61+
## Acknowledgements
62+
63+
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.
64+
If you have any questions, feel free to reach out to us via GitHub issues, Discord or at our next meetup!

‎README.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,19 @@
22

33
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!
44

5-
Live website : https://frontend.mu/
5+
Live website : [https://frontend.mu/](https://frontend.mu/)
66

7-
## Setup
7+
## Getting Started
8+
9+
### Prerequisites
810

911
[Install pnpm](https://pnpm.io/installation) on your development environment for the best experience.
1012

13+
### Dependencies
14+
15+
Use pnpm to install the dependencies.
16+
17+
1118
```
1219
pnpm install
1320
```
@@ -20,30 +27,19 @@ To run the astro project, run the following command
2027
pnpm run astro dev
2128
```
2229

23-
## Environment variables
30+
### Environment variables
2431

2532
Make a copy of .env.example and rename it to .env.development on your local machine.
26-
If not, the application will fail to start
2733

2834
```
2935
cp .env.example .env.development
3036
3137
```
38+
If you don't do this, the application will fail to start
3239

33-
## Feel free to contribute :D
34-
35-
### Run the project locally
36-
37-
1. Fork the repository to get your copy on your account.
38-
2. Clone your forked repository on your machine.
39-
3. Open the cloned `frontend.mu` directory in your code editor.
40-
4. Run `pnpm install` in your terminal.
41-
5. Run `pnpm run nuxt dev`.
42-
43-
### Submit your PR
40+
## Contributing
41+
We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) file for details on how to get started, submit PRs, and more.
4442

45-
1. Commit & push your changes on your forked repository.
46-
2. Log in to your GitHub account & go to your forked repository's page.
47-
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)).
43+
## Community
44+
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!
4845

49-
**Chat with us on [Discord](https://discord.gg/WxXW9Jvv6k?ref=frontend.mu) if you're having any issue! ✌️**

0 commit comments

Comments
 (0)