Skip to content

Latest commit

 

History

History
64 lines (46 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

64 lines (46 loc) · 3.07 KB
Raw

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

Please read and follow our Code of Conduct 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: 
    cp .env.example .env.development
  6. 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.
  • 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!