forked from KendallDoesCoding/quiz
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added contributing guidelines (KendallDoesCoding#79)
* added contributing guidelines * move to github folder. --------- Co-authored-by: Kendall <kendalldoescoding@gmail.com>
- Loading branch information
1 parent
b6b11d2
commit 73170be
Showing
2 changed files
with
94 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 <kendall@kendalldoescoding.tech>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters