Skip to content

Latest commit

 

History

History
113 lines (75 loc) · 4.52 KB

CONTRIBUTING.md

File metadata and controls

113 lines (75 loc) · 4.52 KB
Raw

Contributing to QuizHub

Thank you for considering contributing to QuizHub! Your support and contributions make a significant difference. ❤️

We welcome all types of contributions, from code improvements to feature suggestions and documentation updates. Below, you'll find a detailed guide on how you can help out and how to submit your contributions effectively. Make sure to read the relevant sections before diving in!

Even if you’re unable to contribute directly, we would greatly appreciate your support in other ways:

  • Star the project ⭐
  • Spread the word on social media
  • Reference QuizHub in your projects
  • Share the project with friends and colleagues

Table of Contents

Code of Conduct

This project adheres to the QuizHub Code of Conduct. By participating, you are expected to uphold this code. Report any unacceptable behavior to our team.

I Have a Question

Please check the documentation first. If your question remains unanswered, follow these steps:

  • Search through existing issues.
  • If you find an issue addressing your question but it’s unclear, feel free to ask for clarification in that issue.

If you still need help:

  • Open a new issue.
  • Provide as much context as possible, including environment details (e.g., Node.js version).
  • We will get back to you as soon as possible.

I Want To Contribute

We welcome your contributions! Please follow the steps below to ensure a smooth contribution process.

Reporting Bugs

Before reporting a bug:

  1. Ensure you're using the latest version.
  2. Confirm it’s a bug (not a configuration issue) by reviewing the documentation.
  3. Search the issues tracker to see if the bug has already been reported.

How to submit a bug report:

  • Open a new issue.
  • Clearly describe the expected behavior and the actual behavior.
  • Include steps to reproduce the issue, relevant code snippets, and error logs.
  • Include system details (OS, Node.js version, browser, etc.).

Once submitted, the team will reproduce the issue and label it appropriately.

Suggesting Enhancements

We love new ideas, but please ensure they align with QuizHub’s mission.

Before suggesting an enhancement:

  1. Ensure you're using the latest version.
  2. Review the documentation to confirm the feature doesn’t already exist.
  3. Search existing suggestions to see if a similar idea has been proposed.

How to submit a suggestion:

  • Open a new issue.
  • Provide a detailed description of your enhancement idea.
  • Describe the current behavior and the expected behavior.
  • Explain why this enhancement would be useful for most users.
  • Attach any relevant screenshots or diagrams, if applicable.

Your First Code Contribution

If this is your first time contributing to QuizHub, welcome! 🎉

Here’s how to get started:

  1. Fork the repository and clone it to your local machine.
  2. Follow the setup instructions in the README.md to get your local environment up and running.
  3. Make your changes and ensure everything is working as expected.
  4. Open a pull request with a clear title and description of the changes made.

Improving the Documentation

We always appreciate improvements to our documentation! Whether it’s fixing a typo, clarifying concepts, or adding new examples, you can contribute by opening a pull request.

Styleguides

Commit Messages

Follow these guidelines for commit messages to keep things clean and clear:

  • Use the present tense ("Add feature" not "Added feature").
  • Capitalize the subject line.
  • Be concise but descriptive.

Example:

Add leaderboard sorting by total score