[PLEASE READ] Guide to the Forum

[zhuhanming]

Guide to the CVWO Assignment Forum

Hello all, and welcome to the forum for CVWO Assignment! We hope that you're excited about the assignment and that everyone will get to learn something new from it.

This forum has been created to encourage peer support and learning. This assignment will not be an easy one, and likely most, if not all, of you will encounter challenges along the way, be it inexplicable errors or unexpected bugs. We thus hope that this forum will be a good avenue for everyone to discuss these challenges and help each other out. However, we also hope that you will try your best to resolve any issues encountered by yourself, as much as possible.

As such, we encourage posts/GitHub issues of the following types:

• Request for assistance. (Refer to guidelines below on how to structure such posts)
• Sharing of advice, how you resolved certain issues, etc. (But please do not share entire segments of code!)
• General questions about the assignment.

With all that being said, here are some guidelines for the forum:

Debug First

Before creating an issue for some error or bug you faced along the way, do try to debug it yourself first! This means:

1. Reading and understanding the error message. Very often, the error message tells you where the issue is and what is causing the issue.
2. Googling to see whether anyone else has encountered similar issues and if there's a solution online. Chances are, someone has encountered a similar error before!

Stack Overflow is a popular website for developers to go to when seeking help. But please do not just blindly copy what you find there!

Issue Format

Requests for Assistance

If the debugging steps above do not help, then it's time to create an issue on the forums. Please try to include as much of the following information as you can in your issue:

• A brief description of the error in the issue title. Please do not include more than one error in a single issue. You can create multiple issues if you are facing multiple errors.
• Information about your machine and environment, e.g. Mac running Big Sur, Rails version, etc.
• Describe the error in detail. A good template is: What should happen vs What actually happened.
• Describe the steps to reproduce the error.
• What you have tried so far to fix the error. This is to prevent duplication of debugging efforts.
• The full error message and stacktrace.
• Relevant screenshots, code snippets and links.

All Issues

Tag your issue with the correct labels! This issue is tagged with the must read label - you can see it on the right side! You can tag your issue by clicking the "Labels" word on the right side of GitHub's issue interface and selecting the relevant labels:

• help wanted: This is for technical issues encountered.
• question: This may be for more general questions about the assignment.
• rails: This issue is related to Ruby on Rails.
• react: This issue is related to React.
• mac, windows, linux: Choose the label for your OS.
• advice: For posts containing advice for others!
• Please let us know if there are any other labels that you would like to see!