Skip to content

Commit

Permalink
added contributing guidelines (#79)
Browse files Browse the repository at this point in the history
* added contributing guidelines

* move to github folder.

---------

Co-authored-by: Kendall <[email protected]>
  • Loading branch information
debasish-dutta and KendallDoesCoding authored Dec 11, 2023
1 parent b6b11d2 commit 73170be
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 16 deletions.
59 changes: 59 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Contributing to Quiz

We love your input! We want to make contributing to this project as easy and transparent as possible.

## Ways to Contribute

- Bug Reports
- Submitting fixes
- Discussing the current state of the code
- Feature Requests: Proposing new features
- Become a maintainer

## How to Contribute

### Making Changes

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes and ensure code quality (linting, tests).
3. Commit your changes (git commit -am 'Add new feature').
3. Push to the branch (git push origin feature-branch).
3. Create a new Pull Request.

### How to Start the Project

1. After forking, clone the repo onto your local machine (git clone repo-name).
2. `index.html` is the starting point of the website.
3. The music, css, js and images are in their respective folders.

### Pull Requests (PRs)

- Clearly describe your changes in the PR description.
- Ensure the PR addresses an open issue (if applicable).
- Maintain a clean commit history.

### Code Style

- Follow the existing code style and conventions.
- Document your code and changes wherever necessary.

### Issue Reporting

- Report a bug by opening a new [issue](https://github.com/KendallDoesCoding/quiz/issues/new/choose).
- When reporting bugs, provide detailed steps to reproduce.
- Include relevant information such as OS, browser, or environment.

## Community Guidelines

Be respectful and considerate towards others' contributions.
Accept constructive criticism and feedback gracefully.
Help fellow contributors and maintain a positive environment.

## Licensing

By contributing, you agree that your contributions will be licensed under the project's [LICENSE](https://github.com/KendallDoesCoding/quiz/blob/main/LICENSE).

## Contact

If you have any questions or need further assistance, feel free to contact us at <[email protected]>.
51 changes: 35 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# quiz
# Quiz

Thanks for viewing the GitHub repo for my quiz.
I made this quiz, following a YouTube tutorial online by [Brian Designs](https://www.youtube.com/channel/UCsKsymTY_4BYR-wytLjex7A). You can explore this repo, although if you want to do the quiz yourself, I suggest you don't open any "Javascript" files within the directory /data, because the .JS file there has all the answers to the quiz. I may delete the games directory, and create a private repo where I have everything + games directory, but for now that will cause me double work, so its fine as it is :).
Expand All @@ -11,20 +11,23 @@ I would like to give a big shoutout to [@Hacikoi-the-creator](https://github.com

Incase, music isn't playing for you, please do the following steps:

- Head over to to Google Sound Settings - https://chrome://settings/content/sound?search=Sound
- Head over to to Google Sound Settings - <https://chrome://settings/content/sound?search=Sound>
- Set it to "Sites can play sound"

The issue should be fixed. Incase of any further issue, please file a [Bug Report](https://github.com/KendallDoesCoding/quiz/issues/new?assignees=&labels=%F0%9F%9B%A0+goal%3A+fix&template=bug.yml).

# Links and Topics

[Tutorial Video](https://www.youtube.com/watch?v=f4fB9Xg2JEY)
#### [Tutorial Video](https://www.youtube.com/watch?v=f4fB9Xg2JEY)

[Quiz Question Suggestion Template](https://www.youtube.com/watch?v=KrGfq0vXEkc)
#### [Quiz Question Suggestion Template](https://www.youtube.com/watch?v=KrGfq0vXEkc)

[Quiz Website](https://kendalldoescoding.tech/pages/quiz/index.html)
#### [Quiz Website](https://kendalldoescoding.tech/pages/quiz/index.html)

[Quiz Topics](https://quiz.kendalldoescoding.tech/pages/topics/index.html)
#### [Quiz Topics](https://quiz.kendalldoescoding.tech/pages/topics/index.html)

<details>
<summary>Check more Quiz types</summary>

[Tech Quiz](https://quiz.kendalldoescoding.tech/pages/tech/index.html)

Expand Down Expand Up @@ -58,42 +61,58 @@ The issue should be fixed. Incase of any further issue, please file a [Bug Repor

[Jaiden Animations Quiz](https://quiz.kendalldoescoding.tech/pages/jaidenanimations/index.html)

# Quiz Length Breakdown
</details>

## Quiz Length Breakdown

<details>

### Mini Quiz - _3 Questions_

## Mini Quiz - _3 Questions_
- Browsers Quiz
- How Well Do You Know Kendall Quiz

## Medium Quiz - _5 questions_
### Medium Quiz - _5 questions_

- Tech Quiz
- Disney Quiz
- Country Quiz
- U.S Presidents Quiz
- Programming Language Quiz

## Above Medium Quiz - _7 questions_
### Above Medium Quiz - _7 questions_

- Roblox Quiz

## Normal Quiz - _10 questions_
### Normal Quiz - _10 questions_

- Minecraft Quiz
- Fruit Quiz
- Football Quiz
- YouTube Quiz
- Jaiden Animations Quiz

## Above Normal Quiz - _13 questions_
### Above Normal Quiz - _13 questions_

- Easter Quiz

## Mega Quiz - _15 questions_
### Mega Quiz - _15 questions_

- Main Quiz
- Christmas Quiz
- TheOdd1sOut Quiz

</details>

# Contributing to this Project

Please follow the guidelines [here](./CONTRIBUTING.md) to contribute.

# Music

The following songs are licensed under Creative Commons: By Attribution 3.0 License
http://creativecommons.org/licenses/by/3.0.
Music promoted by https://www.chosic.com/free-music/all
<http://creativecommons.org/licenses/by/3.0>.
Music promoted by <https://www.chosic.com/free-music/all>

- Fluffing a Duck by Kevin Macleod
- Happy and Joyful Children
Expand Down Expand Up @@ -128,4 +147,4 @@ Thanks for your support,

Kendall Does Coding,

[email protected]
<[email protected]>

0 comments on commit 73170be

Please sign in to comment.