Skip to content

Commit 26f14d5

Browse files
committed
doc: copy contributing.md to content folder
1 parent 45e6a2c commit 26f14d5

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed
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!

0 commit comments

Comments
 (0)